saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Replace Nitrogen references with 2017.7.0 in modules/*

Browse source
This commit is contained in:
rallytime 2017-06-14 12:14:27 -06:00
parent 67368b07da
commit 00ecda1002
59 changed files with 223 additions and 223 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
salt/modules/apk.py
View file

@ -8,7 +8,7 @@ Support for apk
*'pkg.install' is not available*), see :ref:`here
<module-provider-override>`.
.. versionadded: Nitrogen
.. versionadded: 2017.7.0
'''
from __future__ import absolute_import

8
salt/modules/aptpkg.py
View file

@ -1590,7 +1590,7 @@ def _consolidate_repo_sources(sources):
def list_repo_pkgs(*args, **kwargs): # pylint: disable=unused-import
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Returns all available packages. Optionally, package names (and name globs)
can be passed and the results will be filtered to packages matching those
@ -1871,7 +1871,7 @@ def del_repo(repo, **kwargs):
def _convert_if_int(value):
'''
.. versionadded:: nitrogen
.. versionadded:: 2017.7.0
Convert to an int if necessary.
@ -1889,7 +1889,7 @@ def _convert_if_int(value):
def get_repo_keys():
'''
.. versionadded:: nitrogen
.. versionadded:: 2017.7.0
List known repo key details.
@ -1961,7 +1961,7 @@ def get_repo_keys():
def add_repo_key(path=None, text=None, keyserver=None, keyid=None, saltenv='base'):
'''
.. versionadded:: nitrogen
.. versionadded:: 2017.7.0
Add a repo key using ``apt-key add``.

16
salt/modules/archive.py
View file

@ -481,7 +481,7 @@ def tar(options, tarfile, sources=None, dest=None,
Comma delimited list of files to **pack** into the tarfile. Can also be
passed as a Python list.
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
Globbing is now supported for this argument
dest
@ -506,7 +506,7 @@ def tar(options, tarfile, sources=None, dest=None,
# Create a tarfile
salt '*' archive.tar -cjvf /tmp/tarfile.tar.bz2 /tmp/file_1,/tmp/file_2
# Create a tarfile using globbing (Nitrogen and later)
# Create a tarfile using globbing (2017.7.0 and later)
salt '*' archive.tar -cjvf /tmp/tarfile.tar.bz2 '/tmp/file_*'
# Unpack a tarfile
salt '*' archive.tar xf foo.tar dest=/target/directory
@ -632,7 +632,7 @@ def cmd_zip(zip_file, sources, template=None, cwd=None, runas=None):
Comma-separated list of sources to include in the zip file. Sources can
also be passed in a Python list.
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
Globbing is now supported for this argument
template : None
@ -669,7 +669,7 @@ def cmd_zip(zip_file, sources, template=None, cwd=None, runas=None):
.. code-block:: bash
salt '*' archive.cmd_zip /tmp/zipfile.zip /tmp/sourcefile1,/tmp/sourcefile2
# Globbing for sources (Nitrogen and later)
# Globbing for sources (2017.7.0 and later)
salt '*' archive.cmd_zip /tmp/zipfile.zip '/tmp/sourcefile*'
'''
cmd = ['zip', '-r']
@ -701,7 +701,7 @@ def zip_(zip_file, sources, template=None, cwd=None, runas=None):
Comma-separated list of sources to include in the zip file. Sources can
also be passed in a Python list.
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
Globbing is now supported for this argument
template : None
@ -734,7 +734,7 @@ def zip_(zip_file, sources, template=None, cwd=None, runas=None):
.. code-block:: bash
salt '*' archive.zip /tmp/zipfile.zip /tmp/sourcefile1,/tmp/sourcefile2
# Globbing for sources (Nitrogen and later)
# Globbing for sources (2017.7.0 and later)
salt '*' archive.zip /tmp/zipfile.zip '/tmp/sourcefile*'
'''
if runas:
@ -1163,7 +1163,7 @@ def rar(rarfile, sources, template=None, cwd=None, runas=None):
Comma-separated list of sources to include in the rar file. Sources can
also be passed in a Python list.
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
Globbing is now supported for this argument
cwd : None
@ -1188,7 +1188,7 @@ def rar(rarfile, sources, template=None, cwd=None, runas=None):
.. code-block:: bash
salt '*' archive.rar /tmp/rarfile.rar /tmp/sourcefile1,/tmp/sourcefile2
# Globbing for sources (Nitrogen and later)
# Globbing for sources (2017.7.0 and later)
salt '*' archive.rar /tmp/rarfile.rar '/tmp/sourcefile*'
'''
cmd = ['rar', 'a', '-idp', '{0}'.format(rarfile)]

2
salt/modules/boto3_elasticache.py
View file

@ -3,7 +3,7 @@
Execution module for Amazon Elasticache using boto3
===================================================
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
:configuration: This module accepts explicit elasticache credentials but can
also utilize IAM roles assigned to the instance through Instance Profiles.

2
salt/modules/boto3_route53.py
View file

@ -2,7 +2,7 @@
'''
Execution module for Amazon Route53 written against Boto 3
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
:configuration: This module accepts explicit route53 credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles.

12
salt/modules/boto_apigateway.py
View file

@ -1408,7 +1408,7 @@ def describe_usage_plans(name=None, plan_id=None, region=None, key=None, keyid=N
'''
Returns a list of existing usage plans, optionally filtered to match a given plan name
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -1460,7 +1460,7 @@ def create_usage_plan(name, description=None, throttle=None, quota=None, region=
'''
Creates a new usage plan with throttling and quotas optionally applied
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
name
Name of the usage plan
@ -1518,7 +1518,7 @@ def update_usage_plan(plan_id, throttle=None, quota=None, region=None, key=None,
'''
Updates an existing usage plan with throttling and quotas
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
plan_id
Id of the created usage plan
@ -1592,7 +1592,7 @@ def delete_usage_plan(plan_id, region=None, key=None, keyid=None, profile=None):
'''
Deletes usage plan identified by plan_id
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -1655,7 +1655,7 @@ def attach_usage_plan_to_apis(plan_id, apis, region=None, key=None, keyid=None,
'''
Attaches given usage plan to each of the apis provided in a list of apiId and stage values
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
apis
a list of dictionaries, where each dictionary contains the following:
@ -1680,7 +1680,7 @@ def detach_usage_plan_from_apis(plan_id, apis, region=None, key=None, keyid=None
'''
Detaches given usage plan from each of the apis provided in a list of apiId and stage value
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
apis
a list of dictionaries, where each dictionary contains the following:

4
salt/modules/boto_ec2.py
View file

@ -450,7 +450,7 @@ def assign_private_ip_addresses(network_interface_name=None, network_interface_i
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
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
'''
if not salt.utils.exactly_one((network_interface_name,
network_interface_id)):
@ -504,7 +504,7 @@ def unassign_private_ip_addresses(network_interface_name=None, network_interface
salt myminion boto_ec2.unassign_private_ip_addresses network_interface_name=my_eni private_ip_addresses=private_ip
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
'''
if not salt.utils.exactly_one((network_interface_name,
network_interface_id)):

2
salt/modules/boto_efs.py
View file

@ -2,7 +2,7 @@
'''
Connection module for Amazon EFS
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
:configuration: This module accepts explicit EFS credentials but can also
utilize IAM roles assigned to the instance through Instance Profiles or

2
salt/modules/boto_kinesis.py
View file

@ -2,7 +2,7 @@
'''
Connection module for Amazon Kinesis
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
:configuration: This module accepts explicit Kinesis credentials but can also
utilize IAM roles assigned to the instance trough Instance Profiles.

4
salt/modules/boto_lambda.py
View file

@ -240,7 +240,7 @@ def create_function(FunctionName, Runtime, Role, Handler, ZipFile=None,
}
}
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Returns {created: true} if the function was created and returns
{created: False} if the function was not created.
@ -385,7 +385,7 @@ def update_function_config(FunctionName, Role=None, Handler=None,
}
}
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Returns {updated: true} if the function was updated and returns
{updated: False} if the function was not updated.

2
salt/modules/bower.py
View file

@ -219,7 +219,7 @@ def list_(dir, runas=None, env=None):
def prune(dir, runas=None, env=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Remove extraneous local Bower packages, i.e. those not referenced in bower.json

2
salt/modules/capirca_acl.py
View file

@ -5,7 +5,7 @@ Capirca ACL
Generate ACL (firewall) configuration for network devices.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
:codeauthor: Mircea Ulinic <mircea@cloudflare.com> & Robert Ankeny <robankeny@google.com>
:maturity: new

4
salt/modules/chocolatey.py
View file

@ -241,7 +241,7 @@ def list_(narrow=None,
Display only packages that match ``narrow`` exactly. Default is
False.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Returns:
dict: A dictionary of results.
@ -405,7 +405,7 @@ def install(name,
Allow multiple versions of the package to be installed. Do not use
with ``force``. Does not work with all packages. Default is False.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Returns:
str: The output of the ``chocolatey`` command

26
salt/modules/dockermod.py
View file

@ -3,7 +3,7 @@
Management of Docker Containers
.. versionadded:: 2015.8.0
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
This module has replaced the legacy docker execution module.
:depends: docker_ Python module
@ -56,7 +56,7 @@ For example:
password: s3cr3t
.. note::
As of the 2016.3.7, 2016.11.4, and Nitrogen releases of Salt, credentials
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 ``hub`` in place
of the registry URL. In earlier releases, it is necessary to specify the
actual registry URL for the Docker Hub (i.e.
@ -119,7 +119,7 @@ Executing Commands Within a Running Container
.. note::
With the release of Docker 1.13.1, the Execution Driver has been removed.
Starting in versions 2016.3.6, 2016.11.4, and Nitrogen, Salt defaults to
Starting in versions 2016.3.6, 2016.11.4, and 2017.7.0, Salt defaults to
using ``docker exec`` to run commands in containers, however for older Salt
releases it will be necessary to set the ``docker.exec_driver`` config
option to either ``docker-exec`` or ``nsenter`` for Docker versions 1.13.1
@ -767,8 +767,8 @@ def _error_detail(data, item):
# Functions to handle docker-py client args
def get_client_args():
'''
.. versionadded:: 2016.3.6,2016.11.4,Nitrogen
.. versionchanged:: Nitrogen
.. versionadded:: 2016.3.6,2016.11.4,2017.7.0
.. versionchanged:: 2017.7.0
Replaced the container config args with the ones from the API's
``create_container`` function.
@ -852,7 +852,7 @@ def _get_create_kwargs(image,
def compare_container(first, second, ignore=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Compare two containers' Config and and HostConfig and return any
differences between the two.
@ -902,7 +902,7 @@ def compare_container(first, second, ignore=None):
def login(*registries):
'''
.. versionadded:: 2016.3.7,2016.11.4,Nitrogen
.. versionadded:: 2016.3.7,2016.11.4,2017.7.0
Performs a ``docker login`` to authenticate to one or more configured
repositories. See the documentation at the top of this page to configure
@ -1283,7 +1283,7 @@ def info():
def inspect(name):
'''
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
Volumes and networks are now checked, in addition to containers and
images.
@ -2888,7 +2888,7 @@ def rm_(name, force=False, volumes=False, **kwargs):
option is set to ``False`` by default to prevent accidental removal of
a running container.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
volumes : False
Also remove volumes associated with container
@ -2926,7 +2926,7 @@ def rm_(name, force=False, volumes=False, **kwargs):
def rename(name, new_name):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Renames a container. Returns ``True`` if successful, and raises an error if
the API returns one. If unsuccessful and the API returns no error (should
@ -3923,7 +3923,7 @@ def tag_(name, image, force=False):
# Network Management
def networks(names=None, ids=None):
'''
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
The ``names`` and ``ids`` can be passed as a comma-separated list now,
as well as a Python list.
@ -4031,7 +4031,7 @@ def connect_container_to_network(container, network_id, ipv4_address=None):
ipv4_address
The IPv4 address to connect to the container
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -4348,7 +4348,7 @@ def stop(name, timeout=None, **kwargs):
Timeout in seconds after which the container will be killed (if it has
not yet gracefully shut down)
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
If this argument is not passed, then the container's configuration
will be checked. If the container was created using the
``stop_timeout`` argument, then the configured timeout will be

46
salt/modules/elasticsearch.py
View file

@ -152,7 +152,7 @@ def _get_instance(hosts=None, profile=None):
def ping(allow_failure=False, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Test connection to Elasticsearch instance. This method does not fail if not explicitly specified.
@ -175,7 +175,7 @@ def ping(allow_failure=False, hosts=None, profile=None):
def info(hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return Elasticsearch information.
@ -194,7 +194,7 @@ def info(hosts=None, profile=None):
def node_info(nodes=None, flat_settings=False, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return Elasticsearch node information.
@ -217,7 +217,7 @@ def node_info(nodes=None, flat_settings=False, hosts=None, profile=None):
def cluster_health(index=None, level='cluster', local=False, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return Elasticsearch cluster health.
@ -242,7 +242,7 @@ def cluster_health(index=None, level='cluster', local=False, hosts=None, profile
def cluster_stats(nodes=None, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return Elasticsearch cluster stats.
@ -548,7 +548,7 @@ def index_get(index, hosts=None, profile=None):
def index_open(index, allow_no_indices=True, expand_wildcards='closed', ignore_unavailable=True, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Open specified index.
@ -577,7 +577,7 @@ def index_open(index, allow_no_indices=True, expand_wildcards='closed', ignore_u
def index_close(index, allow_no_indices=True, expand_wildcards='open', ignore_unavailable=True, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Close specified index.
@ -762,7 +762,7 @@ def index_template_get(name, hosts=None, profile=None):
def pipeline_get(id, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Retrieve Ingest pipeline definition. Available since Elasticsearch 5.0.
@ -787,7 +787,7 @@ def pipeline_get(id, hosts=None, profile=None):
def pipeline_delete(id, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Delete Ingest pipeline. Available since Elasticsearch 5.0.
@ -813,7 +813,7 @@ def pipeline_delete(id, hosts=None, profile=None):
def pipeline_create(id, body, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Create Ingest pipeline by supplied definition. Available since Elasticsearch 5.0.
@ -838,7 +838,7 @@ def pipeline_create(id, body, hosts=None, profile=None):
def pipeline_simulate(id, body, verbose=False, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Simulate existing Ingest pipeline on provided data. Available since Elasticsearch 5.0.
@ -864,7 +864,7 @@ def pipeline_simulate(id, body, verbose=False, hosts=None, profile=None):
def search_template_get(id, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Obtain existing search template definition.
@ -887,7 +887,7 @@ def search_template_get(id, hosts=None, profile=None):
def search_template_create(id, body, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Create search template by supplied definition
@ -912,7 +912,7 @@ def search_template_create(id, body, hosts=None, profile=None):
def search_template_delete(id, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Delete existing search template definition.
@ -937,7 +937,7 @@ def search_template_delete(id, hosts=None, profile=None):
def repository_get(name, local=False, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Get existing repository details.
@ -962,7 +962,7 @@ def repository_get(name, local=False, hosts=None, profile=None):
def repository_create(name, body, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Create repository for storing snapshots. Note that shared repository paths have to be specified in path.repo Elasticsearch configuration option.
@ -987,7 +987,7 @@ def repository_create(name, body, hosts=None, profile=None):
def repository_delete(name, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Delete existing repository.
@ -1012,7 +1012,7 @@ def repository_delete(name, hosts=None, profile=None):
def repository_verify(name, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Obtain list of cluster nodes which successfully verified this repository.
@ -1035,7 +1035,7 @@ def repository_verify(name, hosts=None, profile=None):
def snapshot_status(repository=None, snapshot=None, ignore_unavailable=False, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Obtain status of all currently running snapshots.
@ -1060,7 +1060,7 @@ def snapshot_status(repository=None, snapshot=None, ignore_unavailable=False, ho
def snapshot_get(repository, snapshot, ignore_unavailable=False, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Obtain snapshot residing in specified repository.
@ -1085,7 +1085,7 @@ def snapshot_get(repository, snapshot, ignore_unavailable=False, hosts=None, pro
def snapshot_create(repository, snapshot, body=None, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Create snapshot in specified repository by supplied definition.
@ -1112,7 +1112,7 @@ def snapshot_create(repository, snapshot, body=None, hosts=None, profile=None):
def snapshot_restore(repository, snapshot, body=None, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Restore existing snapshot in specified repository by supplied definition.
@ -1139,7 +1139,7 @@ def snapshot_restore(repository, snapshot, body=None, hosts=None, profile=None):
def snapshot_delete(repository, snapshot, hosts=None, profile=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Delete snapshot from specified repository.

6
salt/modules/file.py
View file

@ -3233,7 +3233,7 @@ def access(path, mode):
def read(path, binary=False):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the content of the file.
@ -4674,14 +4674,14 @@ def manage_file(name,
See https://docs.python.org/3/library/codecs.html#standard-encodings
for the list of available encodings.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
encoding_errors : 'strict'
Default is ```'strict'```.
See https://docs.python.org/2/library/codecs.html#codec-base-classes
for the error handling schemes.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:

2
salt/modules/freebsd_update.py
View file

@ -2,7 +2,7 @@
'''
Support for freebsd-update utility on FreeBSD.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
:maintainer: George Mamalakis <mamalos@gmail.com>
:maturity: new

46
salt/modules/git.py
View file

@ -399,7 +399,7 @@ def add(cwd,
subcommand), in a single string. This is useful for passing ``-c`` to
run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -524,7 +524,7 @@ def archive(cwd,
``archive`` subcommand), in a single string. This is useful for passing
``-c`` to run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -629,7 +629,7 @@ def branch(cwd,
subcommand), in a single string. This is useful for passing ``-c`` to
run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -708,7 +708,7 @@ def checkout(cwd,
passing ``-c`` to run git with temporary changes to the git
configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -822,7 +822,7 @@ def clone(cwd,
subcommand), in a single string. This is useful for passing ``-c`` to
run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -966,7 +966,7 @@ def commit(cwd,
subcommand), in a single string. This is useful for passing ``-c`` to
run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -1596,7 +1596,7 @@ def diff(cwd,
subcommand), in a single string. This is useful for passing ``-c`` to
run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -1767,7 +1767,7 @@ def fetch(cwd,
subcommand), in a single string. This is useful for passing ``-c`` to
run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -1937,7 +1937,7 @@ def init(cwd,
subcommand), in a single string. This is useful for passing ``-c`` to
run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -2506,7 +2506,7 @@ def ls_remote(cwd=None,
passing ``-c`` to run git with temporary changes to the git
configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -2644,7 +2644,7 @@ def merge(cwd,
subcommand), in a single string. This is useful for passing ``-c`` to
run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -2776,7 +2776,7 @@ def merge_base(cwd,
passing ``-c`` to run git with temporary changes to the git
configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -3002,7 +3002,7 @@ def pull(cwd,
subcommand), in a single string. This is useful for passing ``-c`` to
run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -3114,7 +3114,7 @@ def push(cwd,
subcommand), in a single string. This is useful for passing ``-c`` to
run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -3228,7 +3228,7 @@ def rebase(cwd,
subcommand), in a single string. This is useful for passing ``-c`` to
run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -3677,7 +3677,7 @@ def reset(cwd,
subcommand), in a single string. This is useful for passing ``-c`` to
run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -3752,7 +3752,7 @@ def rev_parse(cwd,
passing ``-c`` to run git with temporary changes to the git
configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -3893,7 +3893,7 @@ def rm_(cwd,
subcommand), in a single string. This is useful for passing ``-c`` to
run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -3962,7 +3962,7 @@ def stash(cwd,
subcommand), in a single string. This is useful for passing ``-c`` to
run git with temporary changes to the git configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -4113,7 +4113,7 @@ def submodule(cwd,
passing ``-c`` to run git with temporary changes to the git
configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -4251,7 +4251,7 @@ def symbolic_ref(cwd,
passing ``-c`` to run git with temporary changes to the git
configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -4422,7 +4422,7 @@ def worktree_add(cwd,
passing ``-c`` to run git with temporary changes to the git
configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.
@ -4547,7 +4547,7 @@ def worktree_prune(cwd,
passing ``-c`` to run git with temporary changes to the git
configuration.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
This is only supported in git 1.7.2 and newer.

6
salt/modules/github.py
View file

@ -804,7 +804,7 @@ def get_repo_teams(repo_name, profile='github'):
'''
Return teams belonging to a repository.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
repo_name
The name of the repository from which to retrieve teams.
@ -1385,7 +1385,7 @@ def add_team_repo(repo_name, team_name, profile="github", permission=None):
'push' or 'admin'. If not specified, the default permission specified on
the team will be used.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -1727,7 +1727,7 @@ def get_prs(repo_name=None,
Returns information for all pull requests in a given repository, based on
the search options provided.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
repo_name
The name of the repository for which to list pull requests. This

2
salt/modules/grafana4.py
View file

@ -2,7 +2,7 @@
'''
Module for working with the Grafana v4 API
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
:depends: requests

4
salt/modules/grains.py
View file

@ -415,7 +415,7 @@ def remove(key, val, delimiter=DEFAULT_TARGET_DELIM):
def delkey(key):
'''
.. versionadded:: nitrogen
.. versionadded:: 2017.7.0
Remove a grain completely from the grain system, this will remove the
grain key and value
@ -765,7 +765,7 @@ def equals(key, value):
Returns ``True`` if matches otherwise ``False``.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:

2
salt/modules/hashutil.py
View file

@ -266,7 +266,7 @@ def github_signature(string, shared_secret, challenge_hmac):
Verify a challenging hmac signature against a string / shared-secret for
github webhooks.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Returns a boolean if the verification succeeded or failed.

2
salt/modules/heat.py
View file

@ -2,7 +2,7 @@
'''
Module for handling OpenStack Heat calls
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
:depends: - heatclient Python module
:configuration: This module is not usable until the user, password, tenant, and

2
salt/modules/icinga2.py
View file

@ -2,7 +2,7 @@
'''
Module to provide icinga2 compatibility to salt.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
:depends: - icinga2 server
'''

2
salt/modules/logmod.py
View file

@ -3,7 +3,7 @@
On-demand logging
=================
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
The sole purpose of this module is logging messages in the (proxy) minion.
It comes very handy when debugging complex Jinja templates, for example:

2
salt/modules/match.py
View file

@ -365,7 +365,7 @@ def search_by(lookup, tgt_type='compound', minion_id=None):
<salt.modules.match.filter_by>` and allows matching values instead of
matching keys. A minion can be matched by multiple entries.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:

2
salt/modules/mattermost.py
View file

@ -2,7 +2,7 @@
'''
Module for sending messages to Mattermost
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
: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

2
salt/modules/msteams.py
View file

@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
'''
Module for sending messages to MS Teams
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
: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.

2
salt/modules/mysql.py
View file

@ -685,7 +685,7 @@ def file_query(database, file_name, **connection_args):
Run an arbitrary SQL query from the specified file and return the
the number of affected rows.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:

2
salt/modules/namecheap_dns.py
View file

@ -2,7 +2,7 @@
'''
Namecheap management
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
General Notes
-------------

2
salt/modules/namecheap_domains.py
View file

@ -2,7 +2,7 @@
'''
Namecheap management
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
General Notes
-------------

2
salt/modules/namecheap_ns.py
View file

@ -2,7 +2,7 @@
'''
Namecheap management
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
General Notes
-------------

2
salt/modules/namecheap_ssl.py
View file

@ -2,7 +2,7 @@
'''
Namecheap management
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
General Notes
-------------

2
salt/modules/namecheap_users.py
View file

@ -2,7 +2,7 @@
'''
Namecheap management
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
General Notes
-------------

2
salt/modules/napalm.py
View file

@ -5,7 +5,7 @@ NAPALM helpers
Helpers for the NAPALM modules.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
'''
from __future__ import absolute_import

2
salt/modules/napalm_acl.py
View file

@ -5,7 +5,7 @@ NAPALM ACL
Generate and load ACL (firewall) configuration on network devices.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
:codeauthor: Mircea Ulinic <mircea@cloudflare.com>
:maturity: new

6
salt/modules/napalm_network.py
View file

@ -16,7 +16,7 @@ Dependencies
- :mod:`napalm proxy minion <salt.proxy.napalm>`
.. versionadded:: 2016.11.0
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
'''
from __future__ import absolute_import
@ -817,7 +817,7 @@ def mac(address='', interface='', vlan=0, **kwargs): # pylint: disable=unused-a
@proxy_napalm_wrap
def config(source=None, **kwargs): # pylint: disable=unused-argument
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Return the whole configuration of the network device.
By default, it will return all possible configuration
@ -870,7 +870,7 @@ def config(source=None, **kwargs): # pylint: disable=unused-argument
@proxy_napalm_wrap
def optics(**kwargs): # pylint: disable=unused-argument
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Fetches the power usage on the various transceivers installed
on the network device (in dBm), and returns a view that conforms with the

2
salt/modules/napalm_route.py
View file

@ -76,7 +76,7 @@ def show(destination, protocol=None, **kwargs): # pylint: disable=unused-argume
protocol (optional)
protocol used to learn the routes to the destination.
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
CLI Example:

2
salt/modules/napalm_yang_mod.py
View file

@ -5,7 +5,7 @@ NAPALM YANG
NAPALM YANG basic operations.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
'''
from __future__ import absolute_import

2
salt/modules/nix.py
View file

@ -3,7 +3,7 @@
Work with Nix packages
======================
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
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 ``$HOME/.nix-profile/``, and the nix store, unless specially set up, should be in ``/nix``. To easily use this

2
salt/modules/npm.py
View file

@ -281,7 +281,7 @@ def list_(pkg=None, dir=None, runas=None, env=None, depth=None):
depth
Limit the depth of the packages listed
.. versionadded:: 2016.11.6, Nitrogen
.. versionadded:: 2016.11.6, 2017.7.0
CLI Example:

8
salt/modules/opkg.py
View file

@ -202,7 +202,7 @@ def install(name=None,
Install a specific version of the package, e.g. 1.2.3~0ubuntu0. Ignored
if "pkgs" or "sources" is passed.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
reinstall : False
Specifying reinstall=True will use ``opkg install --force-reinstall``
@ -213,7 +213,7 @@ def install(name=None,
install --force-reinstall`` will only be used if the installed version
matches the requested version.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Multiple Package Installation Options:
@ -248,7 +248,7 @@ def install(name=None,
Only upgrade the packages (disallow downgrades), if they are already
installed. Default is False.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Returns a dict containing the new package names and versions::
@ -839,7 +839,7 @@ def info_installed(*names, **kwargs):
'''
Return the information of the named package(s), installed on the system.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
:param names:
Names of the packages to get information about. If none are specified,

12
salt/modules/pillar.py
View file

@ -60,7 +60,7 @@ def get(key,
dictionaries, the dictionaries will be recursively merged.
.. versionadded:: 2014.7.0
.. versionchanged:: 2016.3.7,2016.11.4,Nitrogen
.. versionchanged:: 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.
@ -86,13 +86,13 @@ def get(key,
data. This tradeoff in performance however allows for the use case
where pillar data is desired only from a single environment.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
saltenv
Included only for compatibility with
:conf_minion:`pillarenv_from_saltenv`, and is otherwise ignored.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -191,7 +191,7 @@ def items(*args, **kwargs):
will be necessary if the encrypted pillar data must be made
available in an decrypted state pillar/ext_pillar rendering.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
pillarenv
Pass a specific pillar environment from which to compile pillar data.
@ -393,7 +393,7 @@ def raw(key=None):
def ext(external, pillar=None):
'''
.. versionchanged:: 2016.3.6,2016.11.3,Nitrogen
.. versionchanged:: 2016.3.6,2016.11.3,2017.7.0
The supported ext_pillar types are now tunable using the
:conf_master:`on_demand_ext_pillar` config option. Earlier releases
used a hard-coded default.
@ -546,7 +546,7 @@ def filter_by(lookup_dict,
default='default',
base=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Look up the given pillar in a given dictionary and return the result

2
salt/modules/publish.py
View file

@ -205,7 +205,7 @@ def publish(tgt,
- range
- compound
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
The ``expr_form`` argument has been renamed to ``tgt_type``, earlier
releases must use ``expr_form``.

2
salt/modules/raet_publish.py
View file

@ -131,7 +131,7 @@ def publish(tgt,
- range
- compound
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
The ``expr_form`` argument has been renamed to ``tgt_type``, earlier
releases must use ``expr_form``.

22
salt/modules/redismod.py
View file

@ -248,7 +248,7 @@ def hdel(key, *fields, **options):
'''
Delete one of more hash fields.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -268,7 +268,7 @@ def hexists(key, field, host=None, port=None, db=None, password=None):
'''
Determine if a hash fields exists.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -312,7 +312,7 @@ def hincrby(key, field, increment=1, host=None, port=None, db=None, password=Non
'''
Increment the integer value of a hash field by the given number.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -328,7 +328,7 @@ def hincrbyfloat(key, field, increment=1.0, host=None, port=None, db=None, passw
'''
Increment the float value of a hash field by the given number.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -344,7 +344,7 @@ def hlen(key, host=None, port=None, db=None, password=None):
'''
Returns number of fields of a hash.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -360,7 +360,7 @@ def hmget(key, *fields, **options):
'''
Returns the values of all the given hash fields.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -380,7 +380,7 @@ def hmset(key, **fieldsvals):
'''
Sets multiple hash fields to multiple values.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -400,7 +400,7 @@ def hset(key, field, value, host=None, port=None, db=None, password=None):
'''
Set the value of a hash field.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -416,7 +416,7 @@ def 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.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -432,7 +432,7 @@ def hvals(key, host=None, port=None, db=None, password=None):
'''
Return all the values in a hash.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -448,7 +448,7 @@ def hscan(key, cursor=0, match=None, count=None, host=None, port=None, db=None,
'''
Incrementally iterate hash fields and associated values.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:

2
salt/modules/rpmbuild.py
View file

@ -176,7 +176,7 @@ def make_src_pkg(dest_dir, spec, sources, env=None, template=None, saltenv='base
This example command should build the libnacl SOURCE package and place it in
/var/www/html/ on the minion
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
.. note::

10
salt/modules/saltutil.py
View file

@ -337,7 +337,7 @@ def sync_states(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blackl
def refresh_grains(**kwargs):
'''
.. versionadded:: 2016.3.6,2016.11.4,Nitrogen
.. versionadded:: 2016.3.6,2016.11.4,2017.7.0
Refresh the minion's grains without syncing custom grains modules from
``salt://_grains``.
@ -581,7 +581,7 @@ sync_outputters = salt.utils.alias_function(sync_output, 'sync_outputters')
def sync_clouds(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Sync utility modules from ``salt://_cloud`` to the minion
@ -651,7 +651,7 @@ def sync_utils(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blackli
def list_extmods():
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
List Salt modules which have been synced externally
@ -1255,7 +1255,7 @@ def cmd(tgt,
ssh=False,
**kwargs):
'''
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
The ``expr_form`` argument has been renamed to ``tgt_type``, earlier
releases must use ``expr_form``.
@ -1305,7 +1305,7 @@ def cmd_iter(tgt,
ssh=False,
**kwargs):
'''
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
The ``expr_form`` argument has been renamed to ``tgt_type``, earlier
releases must use ``expr_form``.

4
salt/modules/solarisips.py
View file

@ -167,10 +167,10 @@ def list_upgrades(refresh=True, **kwargs): # pylint: disable=W0613
Runs a full package database refresh before listing. Set to ``False`` to
disable running the refresh.
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
In previous versions of Salt, ``refresh`` defaulted to ``False``. This was
changed to default to ``True`` in the Nitrogen release to make the behavior
changed to default to ``True`` in the 2017.7.0 release to make the behavior
more consistent with the other package modules, which all default to ``True``.
CLI Example:

2
salt/modules/solrcloud.py
View file

@ -2,7 +2,7 @@
'''
Module for solrcloud configuration
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
For now, module is limited to http-exposed API. It doesn't implement config upload via Solr zkCli
'''

8
salt/modules/ssh.py
View file

@ -240,7 +240,7 @@ def _fingerprint(public_key, fingerprint_hash_type=None):
was originally hashed with. This defaults to ``sha256`` if not specified.
.. versionadded:: 2016.11.4
.. versionchanged:: Nitrogen: default changed from ``md5`` to ``sha256``
.. versionchanged:: 2017.7.0: default changed from ``md5`` to ``sha256``
'''
if fingerprint_hash_type:
@ -248,7 +248,7 @@ def _fingerprint(public_key, fingerprint_hash_type=None):
else:
# Set fingerprint_hash_type to md5 as default
log.warning('Public Key hashing currently defaults to "md5". This will '
'change to "sha256" in the Nitrogen release.')
'change to "sha256" in the 2017.7.0 release.')
hash_type = 'sha256'
try:
@ -828,7 +828,7 @@ def recv_known_host(hostname,
was originally hashed with. This defaults to ``sha256`` if not specified.
.. versionadded:: 2016.11.4
.. versionchanged:: Nitrogen: default changed from ``md5`` to ``sha256``
.. versionchanged:: 2017.7.0: default changed from ``md5`` to ``sha256``
CLI Example:
@ -1001,7 +1001,7 @@ def set_known_host(user=None,
was originally hashed with. This defaults to ``sha256`` if not specified.
.. versionadded:: 2016.11.4
.. versionchanged:: Nitrogen: default changed from ``md5`` to ``sha256``
.. versionchanged:: 2017.7.0: default changed from ``md5`` to ``sha256``
CLI Example:

2
salt/modules/state.py
View file

@ -1140,7 +1140,7 @@ def top(topfn,
:conf_minion:`pillarenv` minion config option nor this CLI argument is
used, all Pillar environments will be merged together.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:

2
salt/modules/statuspage.py
View file

@ -16,7 +16,7 @@ In the minion configuration file, the following block is required:
api_key: <API_KEY>
page_id: <PAGE_ID>
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
'''
from __future__ import absolute_import

40
salt/modules/systemd.py
View file

@ -616,7 +616,7 @@ def unmask_(name, runtime=False):
runtime : False
Set to ``True`` to unmask this service only until the next reboot
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
In previous versions, this function would remove whichever mask was
identified by running ``systemctl is-enabled`` on the service.
However, since it is possible to both have both indefinite and
@ -701,7 +701,7 @@ def masked(name, runtime=False):
is-enabled`` command (so that a persistent mask can be distinguished
from a runtime mask). If the service is not masked, then ``False`` will
be returned.
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
This function now returns a boolean telling the user whether a mask
specified by the new ``runtime`` argument is set. If ``runtime`` is
``False``, this function will return ``True`` if an indefinite mask is
@ -714,7 +714,7 @@ def masked(name, runtime=False):
runtime : False
Set to ``True`` to check for a runtime mask
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
In previous versions, this function would simply return the output
of ``systemctl is-enabled`` when the service was found to be
masked. However, since it is possible to both have both indefinite
@ -771,13 +771,13 @@ def start(name, no_block=False, unmask=False, unmask_runtime=False):
no_block : False
Set to ``True`` to start the service using ``--no-block``.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
unmask : False
Set to ``True`` to remove an indefinite mask before attempting to start
the service.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
In previous releases, Salt would simply unmask a service before
starting. This behavior is no longer the default.
@ -785,7 +785,7 @@ def start(name, no_block=False, unmask=False, unmask_runtime=False):
Set to ``True`` to remove a runtime mask before attempting to start the
service.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
In previous releases, Salt would simply unmask a service before
starting. This behavior is no longer the default.
@ -827,7 +827,7 @@ def stop(name, no_block=False):
no_block : False
Set to ``True`` to start the service using ``--no-block``.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
@ -860,13 +860,13 @@ def restart(name, no_block=False, unmask=False, unmask_runtime=False):
no_block : False
Set to ``True`` to start the service using ``--no-block``.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
unmask : False
Set to ``True`` to remove an indefinite mask before attempting to
restart the service.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
In previous releases, Salt would simply unmask a service before
restarting. This behavior is no longer the default.
@ -874,7 +874,7 @@ def restart(name, no_block=False, unmask=False, unmask_runtime=False):
Set to ``True`` to remove a runtime mask before attempting to restart
the service.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
In previous releases, Salt would simply unmask a service before
restarting. This behavior is no longer the default.
@ -916,13 +916,13 @@ def reload_(name, no_block=False, unmask=False, unmask_runtime=False):
no_block : False
Set to ``True`` to reload the service using ``--no-block``.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
unmask : False
Set to ``True`` to remove an indefinite mask before attempting to
reload the service.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
In previous releases, Salt would simply unmask a service before
reloading. This behavior is no longer the default.
@ -930,7 +930,7 @@ def reload_(name, no_block=False, unmask=False, unmask_runtime=False):
Set to ``True`` to remove a runtime mask before attempting to reload
the service.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
In previous releases, Salt would simply unmask a service before
reloading. This behavior is no longer the default.
@ -974,13 +974,13 @@ def force_reload(name, no_block=True, unmask=False, unmask_runtime=False):
no_block : False
Set to ``True`` to start the service using ``--no-block``.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
unmask : False
Set to ``True`` to remove an indefinite mask before attempting to
force-reload the service.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
In previous releases, Salt would simply unmask a service before
force-reloading. This behavior is no longer the default.
@ -988,7 +988,7 @@ def force_reload(name, no_block=True, unmask=False, unmask_runtime=False):
Set to ``True`` to remove a runtime mask before attempting to
force-reload the service.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
In previous releases, Salt would simply unmask a service before
force-reloading. This behavior is no longer the default.
@ -1052,13 +1052,13 @@ def enable(name, no_block=False, unmask=False, unmask_runtime=False, **kwargs):
no_block : False
Set to ``True`` to start the service using ``--no-block``.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
unmask : False
Set to ``True`` to remove an indefinite mask before attempting to
enable the service.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
In previous releases, Salt would simply unmask a service before
enabling. This behavior is no longer the default.
@ -1066,7 +1066,7 @@ def enable(name, no_block=False, unmask=False, unmask_runtime=False, **kwargs):
Set to ``True`` to remove a runtime mask before attempting to enable
the service.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
In previous releases, Salt would simply unmask a service before
enabling. This behavior is no longer the default.
@ -1124,7 +1124,7 @@ def disable(name, no_block=False, **kwargs): # pylint: disable=unused-argument
no_block : False
Set to ``True`` to start the service using ``--no-block``.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:

12
salt/modules/win_dsc.py
View file

@ -123,19 +123,19 @@ def run_config(path,
file containing the proper hash table or the PowerShell code to
create the hash table.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
config_data_source (str): The path to the ``.psd1`` file on
``file_roots`` to cache at the location specified by
``config_data``. If this is specified, ``config_data`` must be a
local path instead of a hash table.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
script_parameters (str): Any additional parameters expected by the
configuration script. These must be defined in the script itself.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
salt_env (str): The salt environment to use when copying the source.
Default is 'base'
@ -205,19 +205,19 @@ def compile_config(path,
file containing the proper hash table or the PowerShell code to
create the hash table.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
config_data_source (str): The path to the ``.psd1`` file on
``file_roots`` to cache at the location specified by
``config_data``. If this is specified, ``config_data`` must be a
local path instead of a hash table.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
script_parameters (str): Any additional parameters expected by the
configuration script. These must be defined in the script itself.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
salt_env (str): The salt environment to use when copying the source.
Default is 'base'

26
salt/modules/win_iis.py
View file

@ -303,7 +303,7 @@ def modify_site(name, sourcepath=None, apppool=None):
'''
Modify a basic website in IIS.
..versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Args:
name (str): The IIS site name.
@ -412,7 +412,7 @@ def stop_site(name):
'''
Stop a Web Site in IIS.
..versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Args:
name (str): The name of the website to stop.
@ -437,7 +437,7 @@ def start_site(name):
'''
Start a Web Site in IIS.
..versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Args:
name (str): The name of the website to start.
@ -462,7 +462,7 @@ def restart_site(name):
'''
Restart a Web Site in IIS.
..versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Args:
name (str): The name of the website to restart.
@ -598,7 +598,7 @@ def modify_binding(site, binding, hostheader=None, ipaddress=None, port=None,
Modify an IIS Web Binding. Use ``site`` and ``binding`` to target the
binding.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Args:
site (str): The IIS site name.
@ -1085,7 +1085,7 @@ def stop_apppool(name):
'''
Stop an IIS application pool.
..versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Args:
name (str): The name of the App Pool to stop.
@ -1110,7 +1110,7 @@ def start_apppool(name):
'''
Start an IIS application pool.
..versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Args:
name (str): The name of the App Pool to start.
@ -1633,7 +1633,7 @@ def list_backups():
r'''
List the IIS Configuration Backups on the System.
..versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
Backups are made when a configuration is edited. Manual backups are
@ -1678,7 +1678,7 @@ def create_backup(name):
r'''
Backup an IIS Configuration on the System.
..versionadded:: Nitrogen
.. versionadded:: 2017.7.0
.. note::
Backups are stored in the ``$env:Windir\System32\inetsrv\backup``
@ -1716,7 +1716,7 @@ def remove_backup(name):
'''
Remove an IIS Configuration backup from the System.
..versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Args:
name (str): The name of the backup to remove
@ -1752,7 +1752,7 @@ def list_worker_processes(apppool):
Returns a list of worker processes that correspond to the passed
application pool.
..versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Args:
apppool (str): The application pool to query
@ -1798,7 +1798,7 @@ def get_webapp_settings(name, site, settings):
Available settings: physicalPath, applicationPool, userName, password
Returns:
dict: A dictionary of the provided settings and their values.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt '*' win_iis.get_webapp_settings name='app0' site='Default Web Site'
@ -1871,7 +1871,7 @@ def set_webapp_settings(name, site, settings):
: password: "connectAs" password for user
:return: A boolean representing whether all changes succeeded.
:rtype: bool
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Example:
.. code-block:: bash
salt '*' win_iis.set_webapp_settings name='app0' site='site0' settings="{'physicalPath': 'C:\site0', 'apppool': 'site0'}"

36
salt/modules/win_wua.py
View file

@ -57,7 +57,7 @@ def available(software=True,
severities=None,
):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
List updates that match the passed criteria.
@ -181,7 +181,7 @@ def available(software=True,
def list_update(name, download=False, install=False):
'''
.. deprecated:: Nitrogen
.. deprecated:: 2017.7.0
Use :func:`get` instead
Returns details for all updates that match the search criteria
@ -249,14 +249,14 @@ def list_update(name, download=False, install=False):
'''
salt.utils.warn_until(
'Fluorine',
'This function is replaced by \'get\' as of Salt Nitrogen. This'
'This function is replaced by \'get\' as of Salt 2017.7.0. This'
'warning will be removed in Salt Fluorine.')
return get(name, download, install)
def get(name, download=False, install=False):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Returns details for all updates that match the search criteria
@ -350,7 +350,7 @@ def list_updates(software=True,
download=False,
install=False):
'''
.. deprecated:: Nitrogen
.. deprecated:: 2017.7.0
Use :func:`list` instead
Returns a detailed list of available updates or a summary. If download or
@ -465,7 +465,7 @@ def list_updates(software=True,
'''
salt.utils.warn_until(
'Fluorine',
'This function is replaced by \'list\' as of Salt Nitrogen. This'
'This function is replaced by \'list\' as of Salt 2017.7.0. This'
'warning will be removed in Salt Fluorine.')
return list(software, drivers, summary, skip_installed, categories,
severities, download, install)
@ -480,7 +480,7 @@ def list(software=True,
download=False,
install=False):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Returns a detailed list of available updates or a summary. If download or
install is True the same list will be downloaded and/or installed.
@ -618,7 +618,7 @@ def list(software=True,
def download_update(name):
'''
.. deprecated:: Nitrogen
.. deprecated:: 2017.7.0
Use :func:`download` instead
Downloads a single update.
@ -645,14 +645,14 @@ def download_update(name):
'''
salt.utils.warn_until(
'Fluorine',
'This function is replaced by \'download\' as of Salt Nitrogen. This'
'This function is replaced by \'download\' as of Salt 2017.7.0. This'
'warning will be removed in Salt Fluorine.')
return download(name)
def download_updates(names):
'''
.. deprecated:: Nitrogen
.. deprecated:: 2017.7.0
Use :func:`download` instead
Downloads updates that match the list of passed identifiers. It's easier to
@ -676,14 +676,14 @@ def download_updates(names):
'''
salt.utils.warn_until(
'Fluorine',
'This function is replaced by \'download\' as of Salt Nitrogen. This'
'This function is replaced by \'download\' as of Salt 2017.7.0. This'
'warning will be removed in Salt Fluorine.')
return download(names)
def download(names):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Downloads updates that match the list of passed identifiers. It's easier to
use this function by using list_updates and setting install=True.
@ -723,7 +723,7 @@ def download(names):
def install_update(name):
'''
.. deprecated:: Nitrogen
.. deprecated:: 2017.7.0
Use :func:`install` instead
Installs a single update
@ -750,14 +750,14 @@ def install_update(name):
'''
salt.utils.warn_until(
'Fluorine',
'This function is replaced by \'install\' as of Salt Nitrogen. This'
'This function is replaced by \'install\' as of Salt 2017.7.0. This'
'warning will be removed in Salt Fluorine.')
return install(name)
def install_updates(names):
'''
.. deprecated:: Nitrogen
.. deprecated:: 2017.7.0
Use :func:`install` instead
Installs updates that match the list of identifiers. It may be easier to use
@ -781,14 +781,14 @@ def install_updates(names):
'''
salt.utils.warn_until(
'Fluorine',
'This function is replaced by \'install\' as of Salt Nitrogen. This'
'This function is replaced by \'install\' as of Salt 2017.7.0. This'
'warning will be removed in Salt Fluorine.')
return install(names)
def install(names):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Installs updates that match the list of identifiers. It may be easier to use
the list_updates function and set install=True.
@ -828,7 +828,7 @@ def install(names):
def uninstall(names):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Uninstall updates.

10
salt/modules/yumpkg.py
View file

@ -641,7 +641,7 @@ def list_repo_pkgs(*args, **kwargs):
<salt.modules.yumpkg.hold>` will only show the currently-installed
version, as locking a package will make other versions appear
unavailable to yum/dnf.
.. versionchanged:: Nitrogen
.. versionchanged:: 2017.7.0
By default, the versions for each package are no longer organized by
repository. To get results organized by repository, use
``byrepo=True``.
@ -713,26 +713,26 @@ def list_repo_pkgs(*args, **kwargs):
Specify a disabled package repository (or repositories) to enable.
(e.g., ``yum --enablerepo='somerepo'``)
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
disablerepo (ignored if ``fromrepo`` is specified)
Specify an enabled package repository (or repositories) to disable.
(e.g., ``yum --disablerepo='somerepo'``)
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
byrepo : False
When ``True``, the return data for each package will be organized by
repository.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
cacheonly : False
When ``True``, the repo information will be retrieved from the cached
repo metadata. This is equivalent to passing the ``-C`` option to
yum/dnf.
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
CLI Examples:

2
salt/modules/zypper.py
View file

@ -316,7 +316,7 @@ __zypper__ = _Zypper()
class Wildcard(object):
'''
.. versionadded:: Nitrogen
.. versionadded:: 2017.7.0
Converts string wildcard to a zypper query.
Example: