diff --git a/conf/minion b/conf/minion index c09c66d590a..f2b66559321 100644 --- a/conf/minion +++ b/conf/minion @@ -33,7 +33,7 @@ # and a warning will be logged. #random_master: False -# NOTE: Deprecated in Salt Fluorine. Use 'random_master' instead. +# NOTE: Deprecated in Salt 2019.2.0. Use 'random_master' instead. #master_shuffle: False # Minions can connect to multiple masters simultaneously (all masters diff --git a/doc/faq.rst b/doc/faq.rst index 2894de2e416..cbc36814324 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -158,7 +158,7 @@ Similarly, custom states are synced to Minions when :py:func:`saltutil.sync_stat They are both also synced when a :ref:`highstate ` is triggered. -As of the Fluorine release, as well as 2017.7.7 and 2018.3.2 in their +As of the 2019.2.0 release, as well as 2017.7.7 and 2018.3.2 in their respective release cycles, the ``sync`` argument to :py:func:`state.apply `/:py:func:`state.sls ` can be used to sync custom types when running individual SLS files. diff --git a/doc/ref/configuration/master.rst b/doc/ref/configuration/master.rst index 7e104d86598..76383965aaf 100644 --- a/doc/ref/configuration/master.rst +++ b/doc/ref/configuration/master.rst @@ -1044,7 +1044,7 @@ cache events are fired when a minion requests a minion data cache refresh. ``http_connect_timeout`` ------------------------ -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Default: ``20`` diff --git a/doc/ref/configuration/minion.rst b/doc/ref/configuration/minion.rst index 75a9d941354..82f0f7fb94a 100644 --- a/doc/ref/configuration/minion.rst +++ b/doc/ref/configuration/minion.rst @@ -213,7 +213,7 @@ minion event bus. The value is expressed in bytes. ``enable_legacy_startup_events`` -------------------------------- -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Default: ``True`` @@ -286,13 +286,13 @@ to the next master in the list if it finds the existing one is dead. ------------------ .. versionadded:: 2014.7.0 -.. deprecated:: Fluorine +.. deprecated:: 2019.2.0 Default: ``False`` .. warning:: - This option has been deprecated in Salt ``Fluorine``. Please use + This option has been deprecated in Salt ``2019.2.0``. Please use :conf_minion:`random_master` instead. .. code-block:: yaml @@ -305,7 +305,7 @@ Default: ``False`` ----------------- .. versionadded:: 2014.7.0 -.. versionchanged:: Fluorine +.. versionchanged:: 2019.2.0 The :conf_minion:`master_failback` option can be used in conjunction with ``random_master`` to force the minion to fail back to the first master in the list if the first master is back online. Note that :conf_minion:`master_type` @@ -1377,7 +1377,7 @@ talking to the intended master. ``http_connect_timeout`` ------------------------ -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Default: ``20`` @@ -1463,7 +1463,7 @@ The password used for HTTP proxy access. ``no_proxy`` ------------ -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Default: ``[]`` @@ -1486,7 +1486,7 @@ Docker Configuration ---------------------- .. versionadded:: 2017.7.8,2018.3.3 -.. versionchanged:: Fluorine +.. versionchanged:: 2019.2.0 The default value is now ``False`` Default: ``True`` diff --git a/doc/topics/cloud/profitbricks.rst b/doc/topics/cloud/profitbricks.rst index a7514bd92e7..cbf0430f003 100644 --- a/doc/topics/cloud/profitbricks.rst +++ b/doc/topics/cloud/profitbricks.rst @@ -156,7 +156,7 @@ command: # salt-cloud --list-sizes my-profitbricks-config -.. versionchanged:: Fluorine +.. versionchanged:: 2019.2.0 One or more public IP address can be reserved with the following command: @@ -196,7 +196,7 @@ The following list explains some of the important properties. - ``disk_type`` - This option allow the disk type to be set to HDD or SSD. The default is HDD. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 - ``image_password`` - A password is set on the image for the "root" or "Administrator" account. This field may only be set during volume creation. @@ -215,7 +215,7 @@ The following list explains some of the important properties. LAN. If no LAN exists, then a new public LAN will be created. The value accepts a LAN ID (integer). - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 - ``public_ips`` - Public IPs assigned to the NIC in the public LAN. @@ -238,7 +238,7 @@ The following list explains some of the important properties. private LAN. If no LAN exists, then a new private LAN will be created. The value accepts a LAN ID (integer). - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 - ``private_ips`` - Private IPs assigned in the private LAN. NAT setting is ignored when this setting is active. diff --git a/doc/topics/grains/index.rst b/doc/topics/grains/index.rst index ec8bcb5ccc3..106f0829cf9 100644 --- a/doc/topics/grains/index.rst +++ b/doc/topics/grains/index.rst @@ -277,7 +277,7 @@ grains in ``_grains`` will override *any* grains of the same name. For custom grains, if the function takes an argument ``grains``, 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 ``core`` grains. This was added in the Fluorine release. +passed in are ``core`` grains. This was added in the 2019.2.0 release. Examples of Grains diff --git a/doc/topics/jinja/index.rst b/doc/topics/jinja/index.rst index 5a58b870c62..d5c868e4c40 100644 --- a/doc/topics/jinja/index.rst +++ b/doc/topics/jinja/index.rst @@ -886,7 +886,7 @@ Example: encoding (usually a ``unicode`` type). This filter was incorrectly-named when it was added. ``json_decode_list`` will be supported until the Neon release. -.. deprecated:: 2018.3.3,Fluorine +.. deprecated:: 2018.3.3,2019.2.0 The :jinja_ref:`tojson` filter accomplishes what this filter was designed to do, making this filter redundant. @@ -919,7 +919,7 @@ Returns: encoding (usually a ``unicode`` type). This filter was incorrectly-named when it was added. ``json_decode_dict`` will be supported until the Neon release. -.. deprecated:: 2018.3.3,Fluorine +.. deprecated:: 2018.3.3,2019.2.0 The :jinja_ref:`tojson` filter accomplishes what this filter was designed to do, making this filter redundant. @@ -946,7 +946,7 @@ Returns: ``tojson`` ---------- -.. versionadded:: 2018.3.3,Fluorine +.. versionadded:: 2018.3.3,2019.2.0 Dumps a data structure to JSON. diff --git a/doc/topics/releases/2017.7.0.rst b/doc/topics/releases/2017.7.0.rst index c6f67491d22..b0831c5e441 100644 --- a/doc/topics/releases/2017.7.0.rst +++ b/doc/topics/releases/2017.7.0.rst @@ -301,7 +301,7 @@ reports of confusion among community members, since the targeting method is published to minions as ``tgt_type``, and appears as ``tgt_type`` in the job cache as well. -While ``expr_form`` will continue to be supported until the **Fluorine** +While ``expr_form`` will continue to be supported until the **2019.2.0** release cycle (two major releases after this one), those who are using the :ref:`LocalClient ` (either directly, or implictly via a :ref:`netapi module `) are encouraged to update their code @@ -566,7 +566,7 @@ of objects (users, databases, roles, etc.). .. _`Moby announcement`: https://blog.docker.com/2017/04/introducing-the-moby-project/ .. _DockerCon: http://2017.dockercon.com/ -The old syntax will continue to work until the **Fluorine** release of Salt. +The old syntax will continue to work until the **2019.2.0** release of Salt. The old ``dockerng`` 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 salt-contrib_). diff --git a/doc/topics/releases/2018.3.0.rst b/doc/topics/releases/2018.3.0.rst index c2aab6e3e23..246b69a4bf5 100644 --- a/doc/topics/releases/2018.3.0.rst +++ b/doc/topics/releases/2018.3.0.rst @@ -250,7 +250,7 @@ examples. .. note:: git_pillar does not yet support variable update intervals, this is targeted - for the next feature release (Fluorine). + for the next feature release (2019.2.0). LDAP via External Authentication Changes ======================================== diff --git a/doc/topics/releases/fluorine.rst b/doc/topics/releases/2019.2.0.rst similarity index 99% rename from doc/topics/releases/fluorine.rst rename to doc/topics/releases/2019.2.0.rst index a9f1421407d..b1540511652 100644 --- a/doc/topics/releases/fluorine.rst +++ b/doc/topics/releases/2019.2.0.rst @@ -1,8 +1,8 @@ -:orphan: +.. _release-2019-2-0: -====================================== -Salt Release Notes - Codename Fluorine -====================================== +=============================================== +Salt 2019.2.0 Release Notes - Codename Fluorine +=============================================== Non-Backward-Compatible Change to YAML Renderer =============================================== @@ -62,7 +62,7 @@ Ansible Playbook State and Execution Modules Along with the including the :py:mod:`ansible modules ` in the Oxygen release, running playbooks has been -added in Fluorine with the :py:func:`playbooks function +added in 2019.2.0 with the :py:func:`playbooks function `. This also includes an :py:func:`ansible playbooks state module ` which can be used on a targeted host to run ansible playbooks, or used in an @@ -918,7 +918,7 @@ Minion Configuration Deprecations --------------------------------- The :conf_minion:`master_shuffle` configuration option is deprecated as of the -``Fluorine`` release. Please use the :conf_minion:`random_master` option instead. +``2019.2.0 `` release. Please use the :conf_minion:`random_master` option instead. Module Deprecations ------------------- @@ -988,7 +988,7 @@ Roster Deprecations - The :py:mod:`cache ` roster has been changed as follows: - Support for ``roster_order`` as a list or tuple has been removed. As of - the ``Fluorine`` release, ``roster_order`` must be a dictionary. + the ``2019.2.0 `` release, ``roster_order`` must be a dictionary. - The ``roster_order`` option now includes IPv6 in addition to IPv4 for the ``private``, ``public``, ``global`` or ``local`` settings. The syntax for diff --git a/doc/topics/releases/version_numbers.rst b/doc/topics/releases/version_numbers.rst index 578c3296635..dda93a4f47b 100644 --- a/doc/topics/releases/version_numbers.rst +++ b/doc/topics/releases/version_numbers.rst @@ -35,7 +35,7 @@ Assigned codenames: - Carbon: ``2016.11.0`` - Nitrogen: ``2017.7.0`` - Oxygen: ``2018.3.0`` -- Fluorine: ``TBD`` +- Fluorine: ``2019.2.0`` - Neon: ``TBD`` - Sodium: ``TBD`` diff --git a/doc/topics/targeting/index.rst b/doc/topics/targeting/index.rst index 7e33681de38..acd8cf22883 100644 --- a/doc/topics/targeting/index.rst +++ b/doc/topics/targeting/index.rst @@ -116,10 +116,10 @@ There are many ways to target individual minions or groups of minions in Salt: Loadable Matchers ================= -.. versionadded:: Flourine +.. versionadded:: 2019.2.0 Internally targeting is implemented with chunks of code called Matchers. As of -the Flourine release, matchers can be loaded dynamically. Currently new matchers +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 diff --git a/doc/topics/targeting/nodegroups.rst b/doc/topics/targeting/nodegroups.rst index 0160949ae79..a319768964f 100644 --- a/doc/topics/targeting/nodegroups.rst +++ b/doc/topics/targeting/nodegroups.rst @@ -59,12 +59,12 @@ To match a nodegroup on the CLI, use the ``-N`` command-line option: salt -N group1 test.ping -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 .. note:: The ``N@`` classifier historically could not be used in compound matches within the CLI or :term:`top file`, it was only recognized in the - :conf_master:`nodegroups` master config file parameter. As of the Fluorine + :conf_master:`nodegroups` master config file parameter. As of the 2019.2.0 release, this limitation no longer exists. To match a nodegroup in your :term:`top file`, make sure to put ``- match: diff --git a/doc/topics/utils/index.rst b/doc/topics/utils/index.rst index 2ea3564f9a7..c0257f9d616 100644 --- a/doc/topics/utils/index.rst +++ b/doc/topics/utils/index.rst @@ -145,7 +145,7 @@ following Salt functions are called: * :py:func:`saltutil.sync_utils ` * :py:func:`saltutil.sync_all ` -As of the Fluorine release, as well as 2017.7.7 and 2018.3.2 in their +As of the 2019.2.0 release, as well as 2017.7.7 and 2018.3.2 in their respective release cycles, the ``sync`` argument to :py:func:`state.apply `/:py:func:`state.sls ` can be used to sync custom types when running individual SLS files. diff --git a/salt/beacons/watchdog.py b/salt/beacons/watchdog.py index 85d8277eac4..01419caad0b 100644 --- a/salt/beacons/watchdog.py +++ b/salt/beacons/watchdog.py @@ -2,7 +2,7 @@ ''' watchdog beacon -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Watch files and translate the changes into salt events diff --git a/salt/beacons/wtmp.py b/salt/beacons/wtmp.py index e9e7adb02be..c5b4f11b772 100644 --- a/salt/beacons/wtmp.py +++ b/salt/beacons/wtmp.py @@ -71,7 +71,7 @@ can be overridden using a ``ut_type`` key in the beacon configuration: This beacon's events include an ``action`` key which will be either ``login`` or ``logout`` depending on the event type. -.. versionchanged:: Fluorine +.. versionchanged:: 2019.2.0 ``action`` key added to beacon event, and ``ut_type`` config parameter added. diff --git a/salt/cloud/clouds/azurearm.py b/salt/cloud/clouds/azurearm.py index 1b5383d0596..e8050dca160 100644 --- a/salt/cloud/clouds/azurearm.py +++ b/salt/cloud/clouds/azurearm.py @@ -5,7 +5,7 @@ Azure ARM Cloud Module .. versionadded:: 2016.11.0 -.. versionchanged:: Fluorine +.. versionchanged:: 2019.2.0 The Azure ARM cloud module is used to control access to Microsoft Azure Resource Manager @@ -1883,7 +1883,7 @@ def list_subnets(call=None, kwargs=None): def create_or_update_vmextension(call=None, kwargs=None): # pylint: disable=unused-argument ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update a VM extension object "inside" of a VM object. @@ -1989,7 +1989,7 @@ def create_or_update_vmextension(call=None, kwargs=None): # pylint: disable=unu def stop(name, call=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Stop (deallocate) a VM @@ -2050,7 +2050,7 @@ def stop(name, call=None): def start(name, call=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Start a VM diff --git a/salt/config/__init__.py b/salt/config/__init__.py index 35a26d71944..c0c272bac6b 100644 --- a/salt/config/__init__.py +++ b/salt/config/__init__.py @@ -136,7 +136,7 @@ VALID_OPTS = { # a master fingerprint with `salt-key -F master` 'master_finger': six.string_types, - # Deprecated in Fluorine. Use 'random_master' instead. + # Deprecated in 2019.2.0. Use 'random_master' instead. # Do not remove! Keep as an alias for usability. 'master_shuffle': bool, diff --git a/salt/engines/libvirt_events.py b/salt/engines/libvirt_events.py index 6d55fba8610..cdb5d1dfe84 100644 --- a/salt/engines/libvirt_events.py +++ b/salt/engines/libvirt_events.py @@ -62,7 +62,7 @@ A polkit rule like the following one will allow `salt` user to connect to libvir :depends: libvirt 1.0.0+ python binding -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 ''' from __future__ import absolute_import, unicode_literals, print_function diff --git a/salt/executors/docker.py b/salt/executors/docker.py index 14080998cd6..1360c8fb3e4 100644 --- a/salt/executors/docker.py +++ b/salt/executors/docker.py @@ -2,7 +2,7 @@ ''' Docker executor module -.. versionadded: Fluorine +.. versionadded: 2019.2.0 Used with the docker proxy minion. ''' diff --git a/salt/modules/aptpkg.py b/salt/modules/aptpkg.py index f0dbbd4c45b..d0b95fdf509 100644 --- a/salt/modules/aptpkg.py +++ b/salt/modules/aptpkg.py @@ -2664,7 +2664,7 @@ def owner(*paths): def show(*names, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Runs an ``apt-cache show`` on the passed package names, and returns the results in a nested dictionary. The top level of the return data will be diff --git a/salt/modules/arista_pyeapi.py b/salt/modules/arista_pyeapi.py index efe1bdcadec..1de840a0f6d 100644 --- a/salt/modules/arista_pyeapi.py +++ b/salt/modules/arista_pyeapi.py @@ -3,7 +3,7 @@ Arista pyeapi ============= -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Execution module to interface the connection with Arista switches, connecting to the remote network device using the diff --git a/salt/modules/azurearm_compute.py b/salt/modules/azurearm_compute.py index 6251354a209..bc7eb7c2e49 100644 --- a/salt/modules/azurearm_compute.py +++ b/salt/modules/azurearm_compute.py @@ -2,7 +2,7 @@ ''' Azure (ARM) Compute Execution Module -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 :maintainer: :maturity: new @@ -79,7 +79,7 @@ def __virtual__(): def availability_set_create_or_update(name, resource_group, **kwargs): # pylint: disable=invalid-name ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update an availability set. @@ -147,7 +147,7 @@ def availability_set_create_or_update(name, resource_group, **kwargs): # pylint def availability_set_delete(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete an availability set. @@ -180,7 +180,7 @@ def availability_set_delete(name, resource_group, **kwargs): def availability_set_get(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get a dictionary representing an availability set's properties. @@ -213,7 +213,7 @@ def availability_set_get(name, resource_group, **kwargs): def availability_sets_list(resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all availability sets within a resource group. @@ -247,7 +247,7 @@ def availability_sets_list(resource_group, **kwargs): def availability_sets_list_available_sizes(name, resource_group, **kwargs): # pylint: disable=invalid-name ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all available virtual machine sizes that can be used to to create a new virtual machine in an existing availability set. @@ -286,7 +286,7 @@ def availability_sets_list_available_sizes(name, resource_group, **kwargs): # p def virtual_machine_capture(name, destination_name, resource_group, prefix='capture-', overwrite=False, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs. @@ -338,7 +338,7 @@ def virtual_machine_capture(name, destination_name, resource_group, prefix='capt def virtual_machine_get(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Retrieves information about the model view or the instance view of a virtual machine. @@ -375,7 +375,7 @@ def virtual_machine_get(name, resource_group, **kwargs): def virtual_machine_convert_to_managed_disks(name, resource_group, **kwargs): # pylint: disable=invalid-name ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation. @@ -411,7 +411,7 @@ def virtual_machine_convert_to_managed_disks(name, resource_group, **kwargs): # def virtual_machine_deallocate(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Power off a virtual machine and deallocate compute resources. @@ -446,7 +446,7 @@ def virtual_machine_deallocate(name, resource_group, **kwargs): def virtual_machine_generalize(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Set the state of a virtual machine to 'generalized'. @@ -478,7 +478,7 @@ def virtual_machine_generalize(name, resource_group, **kwargs): def virtual_machines_list(resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all virtual machines within a resource group. @@ -511,7 +511,7 @@ def virtual_machines_list(resource_group, **kwargs): def virtual_machines_list_all(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all virtual machines within a subscription. @@ -539,7 +539,7 @@ def virtual_machines_list_all(**kwargs): def virtual_machines_list_available_sizes(name, resource_group, **kwargs): # pylint: disable=invalid-name ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Lists all available virtual machine sizes to which the specified virtual machine can be resized. @@ -576,7 +576,7 @@ def virtual_machines_list_available_sizes(name, resource_group, **kwargs): # py def virtual_machine_power_off(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Power off (stop) a virtual machine. @@ -611,7 +611,7 @@ def virtual_machine_power_off(name, resource_group, **kwargs): def virtual_machine_restart(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Restart a virtual machine. @@ -646,7 +646,7 @@ def virtual_machine_restart(name, resource_group, **kwargs): def virtual_machine_start(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Power on (start) a virtual machine. @@ -681,7 +681,7 @@ def virtual_machine_start(name, resource_group, **kwargs): def virtual_machine_redeploy(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Redeploy a virtual machine. diff --git a/salt/modules/azurearm_network.py b/salt/modules/azurearm_network.py index 93056cf8263..9f68b721bbf 100644 --- a/salt/modules/azurearm_network.py +++ b/salt/modules/azurearm_network.py @@ -2,7 +2,7 @@ ''' Azure (ARM) Network Execution Module -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 :maintainer: :maturity: new @@ -86,7 +86,7 @@ def __virtual__(): def check_dns_name_availability(name, region, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Check whether a domain name in the current zone is available for use. @@ -118,7 +118,7 @@ def check_dns_name_availability(name, region, **kwargs): def check_ip_address_availability(ip_address, virtual_network, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Check that a private ip address is available within the specified virtual network. @@ -154,7 +154,7 @@ def check_ip_address_availability(ip_address, virtual_network, resource_group, def default_security_rule_get(name, security_group, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a default security rule within a security group. @@ -203,7 +203,7 @@ def default_security_rule_get(name, security_group, resource_group, **kwargs): def default_security_rules_list(security_group, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List default security rules within a security group. @@ -243,7 +243,7 @@ def default_security_rules_list(security_group, resource_group, **kwargs): def security_rules_list(security_group, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List security rules within a network security group. @@ -279,7 +279,7 @@ def security_rule_create_or_update(name, access, direction, priority, protocol, destination_address_prefixes=None, source_port_ranges=None, destination_port_ranges=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update a security rule within a specified network security group. @@ -412,7 +412,7 @@ def security_rule_create_or_update(name, access, direction, priority, protocol, def security_rule_delete(security_rule, security_group, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a security rule within a specified security group. @@ -449,7 +449,7 @@ def security_rule_delete(security_rule, security_group, resource_group, def security_rule_get(security_rule, security_group, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get a security rule within a specified network security group. @@ -485,7 +485,7 @@ def security_rule_get(security_rule, security_group, resource_group, **kwargs): def network_security_group_create_or_update(name, resource_group, **kwargs): # pylint: disable=invalid-name ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update a network security group. @@ -541,7 +541,7 @@ def network_security_group_create_or_update(name, resource_group, **kwargs): # def network_security_group_delete(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a network security group within a resource group. @@ -574,7 +574,7 @@ def network_security_group_delete(name, resource_group, **kwargs): def network_security_group_get(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a network security group within a resource group. @@ -606,7 +606,7 @@ def network_security_group_get(name, resource_group, **kwargs): def network_security_groups_list(resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all network security groups within a resource group. @@ -639,7 +639,7 @@ def network_security_groups_list(resource_group, **kwargs): def network_security_groups_list_all(**kwargs): # pylint: disable=invalid-name ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all network security groups within a subscription. @@ -667,7 +667,7 @@ def network_security_groups_list_all(**kwargs): # pylint: disable=invalid-name def subnets_list(virtual_network, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all subnets within a virtual network. @@ -704,7 +704,7 @@ def subnets_list(virtual_network, resource_group, **kwargs): def subnet_get(name, virtual_network, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a specific subnet. @@ -741,7 +741,7 @@ def subnet_get(name, virtual_network, resource_group, **kwargs): def subnet_create_or_update(name, address_prefix, virtual_network, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update a subnet. @@ -818,7 +818,7 @@ def subnet_create_or_update(name, address_prefix, virtual_network, resource_grou def subnet_delete(name, virtual_network, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a subnet. @@ -855,7 +855,7 @@ def subnet_delete(name, virtual_network, resource_group, **kwargs): def virtual_networks_list_all(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all virtual networks within a subscription. @@ -882,7 +882,7 @@ def virtual_networks_list_all(**kwargs): def virtual_networks_list(resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all virtual networks within a resource group. @@ -920,7 +920,7 @@ def virtual_network_create_or_update(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update a virtual network. @@ -996,7 +996,7 @@ def virtual_network_create_or_update(name, def virtual_network_delete(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a virtual network. @@ -1029,7 +1029,7 @@ def virtual_network_delete(name, resource_group, **kwargs): def virtual_network_get(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a specific virtual network. @@ -1061,7 +1061,7 @@ def virtual_network_get(name, resource_group, **kwargs): def load_balancers_list_all(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all load balancers within a subscription. @@ -1088,7 +1088,7 @@ def load_balancers_list_all(**kwargs): def load_balancers_list(resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all load balancers within a resource group. @@ -1122,7 +1122,7 @@ def load_balancers_list(resource_group, **kwargs): def load_balancer_get(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a specific load balancer. @@ -1154,7 +1154,7 @@ def load_balancer_get(name, resource_group, **kwargs): def load_balancer_create_or_update(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update a load balancer within a specified resource group. @@ -1328,7 +1328,7 @@ def load_balancer_create_or_update(name, resource_group, **kwargs): def load_balancer_delete(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a load balancer. @@ -1361,7 +1361,7 @@ def load_balancer_delete(name, resource_group, **kwargs): def usages_list(location, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List subscription network usage for a location. @@ -1386,7 +1386,7 @@ def usages_list(location, **kwargs): def network_interface_delete(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a network interface. @@ -1420,7 +1420,7 @@ def network_interface_delete(name, resource_group, **kwargs): def network_interface_get(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a specific network interface. @@ -1454,7 +1454,7 @@ def network_interface_get(name, resource_group, **kwargs): def network_interface_create_or_update(name, ip_configurations, subnet, virtual_network, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update a network interface within a specified resource group. @@ -1575,7 +1575,7 @@ def network_interface_create_or_update(name, ip_configurations, subnet, virtual_ def network_interfaces_list_all(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all network interfaces within a subscription. @@ -1602,7 +1602,7 @@ def network_interfaces_list_all(**kwargs): def network_interfaces_list(resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all network interfaces within a resource group. @@ -1637,7 +1637,7 @@ def network_interfaces_list(resource_group, **kwargs): # pylint: disable=invalid-name def network_interface_get_effective_route_table(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get all route tables for a specific network interface. @@ -1673,7 +1673,7 @@ def network_interface_get_effective_route_table(name, resource_group, **kwargs): # pylint: disable=invalid-name def network_interface_list_effective_network_security_groups(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get all network security groups applied to a specific network interface. @@ -1712,7 +1712,7 @@ def list_virtual_machine_scale_set_vm_network_interfaces(scale_set, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get information about all network interfaces in a specific virtual machine within a scale set. @@ -1753,7 +1753,7 @@ def list_virtual_machine_scale_set_vm_network_interfaces(scale_set, # pylint: disable=invalid-name def list_virtual_machine_scale_set_network_interfaces(scale_set, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get information about all network interfaces within a scale set. @@ -1791,7 +1791,7 @@ def list_virtual_machine_scale_set_network_interfaces(scale_set, resource_group, # pylint: disable=invalid-name def get_virtual_machine_scale_set_network_interface(name, scale_set, vm_index, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get information about a specfic network interface within a scale set. @@ -1833,7 +1833,7 @@ def get_virtual_machine_scale_set_network_interface(name, scale_set, vm_index, r def public_ip_address_delete(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a public IP address. @@ -1866,7 +1866,7 @@ def public_ip_address_delete(name, resource_group, **kwargs): def public_ip_address_get(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a specific public IP address. @@ -1902,7 +1902,7 @@ def public_ip_address_get(name, resource_group, **kwargs): def public_ip_address_create_or_update(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update a public IP address within a specified resource group. @@ -1958,7 +1958,7 @@ def public_ip_address_create_or_update(name, resource_group, **kwargs): def public_ip_addresses_list_all(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all public IP addresses within a subscription. @@ -1985,7 +1985,7 @@ def public_ip_addresses_list_all(**kwargs): def public_ip_addresses_list(resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all public IP addresses within a resource group. @@ -2019,7 +2019,7 @@ def public_ip_addresses_list(resource_group, **kwargs): def route_filter_rule_delete(name, route_filter, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a route filter rule. @@ -2055,7 +2055,7 @@ def route_filter_rule_delete(name, route_filter, resource_group, **kwargs): def route_filter_rule_get(name, route_filter, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a specific route filter rule. @@ -2092,7 +2092,7 @@ def route_filter_rule_get(name, route_filter, resource_group, **kwargs): def route_filter_rule_create_or_update(name, access, communities, route_filter, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update a rule within a specified route filter. @@ -2171,7 +2171,7 @@ def route_filter_rule_create_or_update(name, access, communities, route_filter, def route_filter_rules_list(route_filter, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all routes within a route filter. @@ -2208,7 +2208,7 @@ def route_filter_rules_list(route_filter, resource_group, **kwargs): def route_filter_delete(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a route filter. @@ -2241,7 +2241,7 @@ def route_filter_delete(name, resource_group, **kwargs): def route_filter_get(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a specific route filter. @@ -2277,7 +2277,7 @@ def route_filter_get(name, resource_group, **kwargs): def route_filter_create_or_update(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update a route filter within a specified resource group. @@ -2333,7 +2333,7 @@ def route_filter_create_or_update(name, resource_group, **kwargs): def route_filters_list(resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all route filters within a resource group. @@ -2367,7 +2367,7 @@ def route_filters_list(resource_group, **kwargs): def route_filters_list_all(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all route filters within a subscription. @@ -2394,7 +2394,7 @@ def route_filters_list_all(**kwargs): def route_delete(name, route_table, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a route from a route table. @@ -2430,7 +2430,7 @@ def route_delete(name, route_table, resource_group, **kwargs): def route_get(name, route_table, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a specific route. @@ -2468,7 +2468,7 @@ def route_get(name, route_table, resource_group, **kwargs): def route_create_or_update(name, address_prefix, next_hop_type, route_table, resource_group, next_hop_ip_address=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update a route within a specified route table. @@ -2530,7 +2530,7 @@ def route_create_or_update(name, address_prefix, next_hop_type, route_table, res def routes_list(route_table, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all routes within a route table. @@ -2567,7 +2567,7 @@ def routes_list(route_table, resource_group, **kwargs): def route_table_delete(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a route table. @@ -2600,7 +2600,7 @@ def route_table_delete(name, resource_group, **kwargs): def route_table_get(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a specific route table. @@ -2636,7 +2636,7 @@ def route_table_get(name, resource_group, **kwargs): def route_table_create_or_update(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update a route table within a specified resource group. @@ -2692,7 +2692,7 @@ def route_table_create_or_update(name, resource_group, **kwargs): def route_tables_list(resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all route tables within a resource group. @@ -2726,7 +2726,7 @@ def route_tables_list(resource_group, **kwargs): def route_tables_list_all(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all route tables within a subscription. diff --git a/salt/modules/azurearm_resource.py b/salt/modules/azurearm_resource.py index 041e61a1726..d3ef7822764 100644 --- a/salt/modules/azurearm_resource.py +++ b/salt/modules/azurearm_resource.py @@ -2,7 +2,7 @@ ''' Azure (ARM) Resource Execution Module -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 :maintainer: :maturity: new @@ -80,7 +80,7 @@ def __virtual__(): def resource_groups_list(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all resource groups within a subscription. @@ -107,7 +107,7 @@ def resource_groups_list(**kwargs): def resource_group_check_existence(name, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Check for the existence of a named resource group in the current subscription. @@ -133,7 +133,7 @@ def resource_group_check_existence(name, **kwargs): def resource_group_get(name, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get a dictionary representing a resource group's properties. @@ -161,7 +161,7 @@ def resource_group_get(name, **kwargs): def resource_group_create_or_update(name, location, **kwargs): # pylint: disable=invalid-name ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update a resource group in a given location. @@ -196,7 +196,7 @@ def resource_group_create_or_update(name, location, **kwargs): # pylint: disabl def resource_group_delete(name, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a resource group from the subscription. @@ -223,7 +223,7 @@ def resource_group_delete(name, **kwargs): def deployment_operation_get(operation, deployment, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get a deployment operation within a deployment. @@ -259,7 +259,7 @@ def deployment_operation_get(operation, deployment, resource_group, **kwargs): def deployment_operations_list(name, resource_group, result_limit=10, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all deployment operations within a deployment. @@ -300,7 +300,7 @@ def deployment_operations_list(name, resource_group, result_limit=10, **kwargs): def deployment_delete(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a deployment. @@ -333,7 +333,7 @@ def deployment_delete(name, resource_group, **kwargs): def deployment_check_existence(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Check the existence of a deployment. @@ -367,7 +367,7 @@ def deployment_create_or_update(name, resource_group, deploy_mode='incremental', parameters_link=None, deploy_template=None, template_link=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Deploys resources to a resource group. @@ -472,7 +472,7 @@ def deployment_create_or_update(name, resource_group, deploy_mode='incremental', def deployment_get(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a specific deployment. @@ -504,7 +504,7 @@ def deployment_get(name, resource_group, **kwargs): def deployment_cancel(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Cancel a deployment if in 'Accepted' or 'Running' state. @@ -542,7 +542,7 @@ def deployment_validate(name, resource_group, deploy_mode=None, parameters_link=None, deploy_template=None, template_link=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager. @@ -642,7 +642,7 @@ def deployment_validate(name, resource_group, deploy_mode=None, def deployment_export_template(name, resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Exports the template used for the specified deployment. @@ -674,7 +674,7 @@ def deployment_export_template(name, resource_group, **kwargs): def deployments_list(resource_group, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all deployments within a resource group. @@ -705,7 +705,7 @@ def deployments_list(resource_group, **kwargs): def subscriptions_list_locations(subscription_id=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all locations for a subscription. @@ -744,7 +744,7 @@ def subscriptions_list_locations(subscription_id=None, **kwargs): def subscription_get(subscription_id=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a subscription. @@ -780,7 +780,7 @@ def subscription_get(subscription_id=None, **kwargs): def subscriptions_list(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all subscriptions for a tenant. @@ -807,7 +807,7 @@ def subscriptions_list(**kwargs): def tenants_list(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all tenants for your account. @@ -834,7 +834,7 @@ def tenants_list(**kwargs): def policy_assignment_delete(name, scope, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a policy assignment. @@ -867,7 +867,7 @@ def policy_assignment_delete(name, scope, **kwargs): def policy_assignment_create(name, scope, definition_name, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create a policy assignment. @@ -945,7 +945,7 @@ def policy_assignment_create(name, scope, definition_name, **kwargs): def policy_assignment_get(name, scope, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a specific policy assignment. @@ -977,7 +977,7 @@ def policy_assignment_get(name, scope, **kwargs): def policy_assignments_list_for_resource_group(resource_group, **kwargs): # pylint: disable=invalid-name ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all policy assignments for a resource group. @@ -1011,7 +1011,7 @@ def policy_assignments_list_for_resource_group(resource_group, **kwargs): # pyl def policy_assignments_list(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all policy assignments for a subscription. @@ -1038,7 +1038,7 @@ def policy_assignments_list(**kwargs): def policy_definition_create_or_update(name, policy_rule, **kwargs): # pylint: disable=invalid-name ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create or update a policy definition. @@ -1093,7 +1093,7 @@ def policy_definition_create_or_update(name, policy_rule, **kwargs): # pylint: def policy_definition_delete(name, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete a policy definition. @@ -1122,7 +1122,7 @@ def policy_definition_delete(name, **kwargs): def policy_definition_get(name, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get details about a specific policy definition. @@ -1150,7 +1150,7 @@ def policy_definition_get(name, **kwargs): def policy_definitions_list(hide_builtin=False, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 List all policy definitions for a subscription. diff --git a/salt/modules/cimc.py b/salt/modules/cimc.py index 0398c24e707..82ac61f897a 100644 --- a/salt/modules/cimc.py +++ b/salt/modules/cimc.py @@ -261,7 +261,7 @@ def get_hostname(): ''' Retrieves the hostname from the device. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -395,7 +395,7 @@ def get_power_configuration(): Get the configuration of the power settings from the device. This is only available on some C-Series servers. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -461,7 +461,7 @@ def get_syslog_settings(): ''' Get the Syslog configuration settings from the system. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -633,7 +633,7 @@ def set_hostname(hostname=None): ''' Sets the hostname on the server. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Args: hostname(str): The new hostname to set. @@ -668,7 +668,7 @@ def set_logging_levels(remote=None, local=None): the following options: emergency, alert, critical, error, warning, notice, informational, debug. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Args: remote(str): The logging level for SYSLOG logs. @@ -751,7 +751,7 @@ def 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. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Args: policy(str): The action to be taken when chassis power is restored after @@ -861,7 +861,7 @@ def set_user(uid=None, username=None, password=None, priv=None, status=None): ''' Sets a CIMC user with specified configurations. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Args: uid(int): The user ID slot to create the user account in. diff --git a/salt/modules/ciscoconfparse_mod.py b/salt/modules/ciscoconfparse_mod.py index c20bc585219..2163081218d 100644 --- a/salt/modules/ciscoconfparse_mod.py +++ b/salt/modules/ciscoconfparse_mod.py @@ -2,7 +2,7 @@ ''' Execution module for `ciscoconfparse `_ -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 This module can be used for basic configuration parsing, audit or validation for a variety of network platforms having Cisco IOS style configuration (one diff --git a/salt/modules/cmdmod.py b/salt/modules/cmdmod.py index 544e75d1ee2..0bfaaf38e95 100644 --- a/salt/modules/cmdmod.py +++ b/salt/modules/cmdmod.py @@ -1091,13 +1091,13 @@ def run(cmd, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param bool stdin_raw_newlines: False If ``True``, Salt will not automatically convert the characters ``\\n`` present in the ``stdin`` value to newlines. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -1343,13 +1343,13 @@ def shell(cmd, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param bool stdin_raw_newlines: False If ``True``, Salt will not automatically convert the characters ``\\n`` present in the ``stdin`` value to newlines. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -1568,13 +1568,13 @@ def run_stdout(cmd, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param bool stdin_raw_newlines: False If ``True``, Salt will not automatically convert the characters ``\\n`` present in the ``stdin`` value to newlines. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -1776,13 +1776,13 @@ def run_stderr(cmd, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param bool stdin_raw_newlines: False If ``True``, Salt will not automatically convert the characters ``\\n`` present in the ``stdin`` value to newlines. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2008,13 +2008,13 @@ def run_all(cmd, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param bool stdin_raw_newlines: False If ``True``, Salt will not automatically convert the characters ``\\n`` present in the ``stdin`` value to newlines. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2207,13 +2207,13 @@ def retcode(cmd, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param bool stdin_raw_newlines: False If ``True``, Salt will not automatically convert the characters ``\\n`` present in the ``stdin`` value to newlines. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2456,13 +2456,13 @@ def script(source, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param bool stdin_raw_newlines: False If ``True``, Salt will not automatically convert the characters ``\\n`` present in the ``stdin`` value to newlines. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2703,13 +2703,13 @@ def script_retcode(source, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param bool stdin_raw_newlines: False If ``True``, Salt will not automatically convert the characters ``\\n`` present in the ``stdin`` value to newlines. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -3025,7 +3025,7 @@ def run_chroot(root, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -3508,13 +3508,13 @@ def powershell(cmd, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param bool stdin_raw_newlines: False If ``True``, Salt will not automatically convert the characters ``\\n`` present in the ``stdin`` value to newlines. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :returns: :dict: A dictionary of data returned by the powershell command. @@ -3810,13 +3810,13 @@ def powershell_all(cmd, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param bool stdin_raw_newlines: False If ``True``, Salt will not automatically convert the characters ``\\n`` present in the ``stdin`` value to newlines. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :return: A dictionary with the following entries: @@ -4079,13 +4079,13 @@ def run_bg(cmd, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param bool stdin_raw_newlines: False If ``True``, Salt will not automatically convert the characters ``\\n`` present in the ``stdin`` value to newlines. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: diff --git a/salt/modules/disk.py b/salt/modules/disk.py index d27f22ab0c9..0e0f6eef553 100644 --- a/salt/modules/disk.py +++ b/salt/modules/disk.py @@ -85,7 +85,7 @@ def usage(args=None): ''' Return usage information for volumes mounted on this minion - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 Default for SunOS changed to 1 kilobyte blocks diff --git a/salt/modules/dockermod.py b/salt/modules/dockermod.py index bef7f9786fb..aea77850cac 100644 --- a/salt/modules/dockermod.py +++ b/salt/modules/dockermod.py @@ -2106,7 +2106,7 @@ def port(name, private_port=None): name Container name or ID - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 This value can now be a pattern expression (using the pattern-matching characters defined in fnmatch_). If a pattern expression is used, this function will return a dictionary mapping @@ -5928,7 +5928,7 @@ def wait(name, ignore_already_stopped=False, fail_on_exit_status=False): def prune(containers=False, networks=False, images=False, build=False, volumes=False, system=None, **filters): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Prune Docker's various subsystems @@ -6724,7 +6724,7 @@ def call(name, function, *args, **kwargs): def apply_(name, mods=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Apply states! This function will call highstate or state.sls based on the arguments passed in, ``apply`` is intended to be the main gateway for @@ -6864,7 +6864,7 @@ def highstate(name, saltenv='base', **kwargs): ''' Apply a highstate to the running container - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 The container does not need to have Salt installed, but Python is required. diff --git a/salt/modules/file.py b/salt/modules/file.py index 4a58ffb72be..2e4eaf11bb9 100644 --- a/salt/modules/file.py +++ b/salt/modules/file.py @@ -2526,7 +2526,7 @@ def blockreplace(path, .. versionadded:: 2016.3.4 .. versionchanged:: 2017.7.5,2018.3.1 New behavior added when value is ``None``. - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The default value of this argument will change to ``None`` to match the behavior of the :py:func:`file.blockreplace state ` diff --git a/salt/modules/git.py b/salt/modules/git.py index eec14b63052..dc8071f09d5 100644 --- a/salt/modules/git.py +++ b/salt/modules/git.py @@ -1964,7 +1964,7 @@ def discard_local_changes(cwd, ignore_retcode=False, output_encoding=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Runs a ``git checkout -- `` from the directory specified by ``cwd``. @@ -3829,7 +3829,7 @@ def remote_refs(url, to make this function run faster on repositories with many branches/tags. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 heads : False Restrict output to heads. Can be combined with ``tags``. diff --git a/salt/modules/glusterfs.py b/salt/modules/glusterfs.py index 2598cd71a93..3ca2301e0e9 100644 --- a/salt/modules/glusterfs.py +++ b/salt/modules/glusterfs.py @@ -244,7 +244,7 @@ def create_volume(name, bricks, stripe=False, replica=False, device_vg=False, Gluster documentation. Every third brick in the brick list \ is used as an arbiter brick. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 device_vg If true, specifies volume should use block backend instead of regular \ @@ -718,7 +718,7 @@ def list_quota_volume(name): def get_op_version(name): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Returns the glusterfs volume op-version @@ -753,7 +753,7 @@ def get_op_version(name): def get_max_op_version(): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Returns the glusterfs volume's max op-version value Requires Glusterfs version > 3.9 @@ -787,7 +787,7 @@ def get_max_op_version(): def set_op_version(version): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Set the glusterfs volume op-version @@ -812,7 +812,7 @@ def set_op_version(version): def get_version(): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Returns the version of glusterfs. CLI Example: diff --git a/salt/modules/google_chat.py b/salt/modules/google_chat.py index e739dea64dd..464f2966e52 100644 --- a/salt/modules/google_chat.py +++ b/salt/modules/google_chat.py @@ -2,7 +2,7 @@ ''' Module for sending messages to google chat. -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 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: diff --git a/salt/modules/hadoop.py b/salt/modules/hadoop.py index 68c15417b1b..82f9963eb80 100644 --- a/salt/modules/hadoop.py +++ b/salt/modules/hadoop.py @@ -90,7 +90,7 @@ def dfs(command=None, *args): def dfsadmin_report(arg=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Reports basic filesystem information and statistics. Optional flags may be used to filter the list of displayed DataNodes. diff --git a/salt/modules/iosconfig.py b/salt/modules/iosconfig.py index 3d338b2edae..39f0cc2e26a 100644 --- a/salt/modules/iosconfig.py +++ b/salt/modules/iosconfig.py @@ -2,7 +2,7 @@ ''' Cisco IOS configuration manipulation helpers -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 This module provides a collection of helper functions for Cisco IOS style configuration manipulation. This module does not have external dependencies diff --git a/salt/modules/jira_mod.py b/salt/modules/jira_mod.py index 8f22edfe2f7..93f4cad88cb 100644 --- a/salt/modules/jira_mod.py +++ b/salt/modules/jira_mod.py @@ -3,7 +3,7 @@ JIRA Execution module ===================== -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Execution module to manipulate JIRA tickets via Salt. diff --git a/salt/modules/kapacitor.py b/salt/modules/kapacitor.py index 3dbe73d0cea..5c1d5ec2e5b 100644 --- a/salt/modules/kapacitor.py +++ b/salt/modules/kapacitor.py @@ -16,7 +16,7 @@ Kapacitor execution module. kapacitor.unsafe_ssl: 'false' kapacitor.protocol: 'http' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 This data can also be passed into pillar. Options passed into opts will overwrite options passed into pillar. @@ -149,7 +149,7 @@ def define_task(name, to fetch data from. For backward compatibility, the value of 'database' and 'retention_policy' will be merged as part of dbrps. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 database Which database to fetch data from. diff --git a/salt/modules/kubernetes.py b/salt/modules/kubernetes.py index 6bac8c44b06..b2c8635b87c 100644 --- a/salt/modules/kubernetes.py +++ b/salt/modules/kubernetes.py @@ -24,11 +24,11 @@ provided `kubeconfig` entry is preferred. salt '*' kubernetes.nodes kubeconfig=/etc/salt/k8s/kubeconfig context=minikube .. versionadded: 2017.7.0 -.. versionchanged:: Fluorine +.. versionchanged:: 2019.2.0 .. warning:: - Configuration options changed in Fluorine. The following configuration options have been removed: + Configuration options changed in 2019.2.0. The following configuration options have been removed: - kubernetes.user - kubernetes.password diff --git a/salt/modules/lxd.py b/salt/modules/lxd.py index ae0d95fa672..b2bf418184b 100644 --- a/salt/modules/lxd.py +++ b/salt/modules/lxd.py @@ -2,7 +2,7 @@ ''' Module for managing the LXD daemon and its containers. -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 `LXD(1)`__ is a container "hypervisor". This execution module provides several functions to help manage it and its containers. diff --git a/salt/modules/mac_service.py b/salt/modules/mac_service.py index bf8d62a8d34..857c168384b 100644 --- a/salt/modules/mac_service.py +++ b/salt/modules/mac_service.py @@ -13,11 +13,11 @@ This module has support for services in the following locations. /Library/LaunchDaemons/ /Library/LaunchAgents/ - # As of version "Fluorine" support for user-specific services were added. + # As of version "2019.2.0" support for user-specific services were added. /Users/foo/Library/LaunchAgents/ .. note:: - As of the Fluorine release, if a service is located in a ``LaunchAgent`` + As of the 2019.2.0 release, if a service is located in a ``LaunchAgent`` path and a ``runas`` user is NOT specified, the current console user will be used to properly interact with the service. @@ -157,7 +157,7 @@ def _always_running_service(name): :rtype: bool - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 ''' # get all the info from the launchctl service @@ -201,7 +201,7 @@ def _get_domain_target(name, service_target=False): :rtype: tuple - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 ''' # Get service information @@ -236,7 +236,7 @@ def _launch_agent(name): :rtype: bool - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 ''' # Get the path to the service. diff --git a/salt/modules/mine.py b/salt/modules/mine.py index 3f554edec19..dc63a3984a3 100644 --- a/salt/modules/mine.py +++ b/salt/modules/mine.py @@ -369,7 +369,7 @@ def get_docker(interfaces=None, cidrs=None, with_container_id=False): When :conf_minion:`docker.update_mine` is set to ``False`` for a given minion, no mine data will be populated for that minion, and thus none will be returned for it. - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 :conf_minion:`docker.update_mine` now defaults to ``False`` Get all mine data for :py:func:`docker.ps ` and diff --git a/salt/modules/mod_random.py b/salt/modules/mod_random.py index c7d49d8ab05..641bea073b9 100644 --- a/salt/modules/mod_random.py +++ b/salt/modules/mod_random.py @@ -179,7 +179,7 @@ def rand_int(start=1, end=10, seed=None): seed : Optional hashable object - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 Added seed argument. Will return the same result when run with the same seed. diff --git a/salt/modules/napalm_formula.py b/salt/modules/napalm_formula.py index f2eb9e06fd5..3c951d59f5e 100644 --- a/salt/modules/napalm_formula.py +++ b/salt/modules/napalm_formula.py @@ -3,7 +3,7 @@ NAPALM Formula helpers ====================== -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 This is an Execution Module providing helpers for various NAPALM formulas, e.g., napalm-interfaces-formula, napalm-bgp-formula, napalm-ntp-formula etc., diff --git a/salt/modules/napalm_mod.py b/salt/modules/napalm_mod.py index 8fe888c976a..fae9ecf0327 100644 --- a/salt/modules/napalm_mod.py +++ b/salt/modules/napalm_mod.py @@ -292,9 +292,9 @@ def compliance_report(filepath=None, filepath The absolute path to the validation file. - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 - Beginning with release codename ``Fluorine``, this function has been + Beginning with release codename ``2019.2.0``, 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: @@ -314,20 +314,20 @@ def compliance_report(filepath=None, (including pure Python). string - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 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 'py' renderer requires a file, for example. renderer: ``jinja|yaml`` - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 The renderer pipe to send the file through; this is overridden by a "she-bang" at the top of the file. kwargs - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 Keyword args to pass to Salt's compile_template() function. @@ -420,7 +420,7 @@ def compliance_report(filepath=None, @proxy_napalm_wrap def netmiko_args(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return the key-value arguments used for the authentication arguments for the netmiko module. @@ -491,7 +491,7 @@ def netmiko_args(**kwargs): @proxy_napalm_wrap def netmiko_fun(fun, *args, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Call an arbitrary function from the :mod:`Netmiko` module, passing the authentication details from the existing NAPALM @@ -525,7 +525,7 @@ def netmiko_fun(fun, *args, **kwargs): @proxy_napalm_wrap def netmiko_call(method, *args, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Execute an arbitrary Netmiko method, passing the authentication details from the existing NAPALM connection. @@ -554,7 +554,7 @@ def netmiko_call(method, *args, **kwargs): @proxy_napalm_wrap def netmiko_multi_call(*methods, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Execute a list of arbitrary Netmiko methods, passing the authentication details from the existing NAPALM connection. @@ -581,7 +581,7 @@ def netmiko_multi_call(*methods, **kwargs): @proxy_napalm_wrap def netmiko_commands(*commands, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 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. @@ -631,7 +631,7 @@ def netmiko_commands(*commands, **kwargs): @proxy_napalm_wrap def netmiko_config(*config_commands, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Load a list of configuration commands on the remote device, via Netmiko. @@ -702,7 +702,7 @@ def netmiko_config(*config_commands, **kwargs): @proxy_napalm_wrap def netmiko_conn(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return the connection object with the network device, over Netmiko, passing the authentication details from the existing NAPALM connection. @@ -728,7 +728,7 @@ def netmiko_conn(**kwargs): @proxy_napalm_wrap def junos_rpc(cmd=None, dest=None, format=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Execute an RPC request on the remote Junos device. @@ -788,7 +788,7 @@ def junos_rpc(cmd=None, dest=None, format=None, **kwargs): @proxy_napalm_wrap def junos_commit(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Commit the changes loaded in the candidate configuration. @@ -837,7 +837,7 @@ def junos_commit(**kwargs): @proxy_napalm_wrap def junos_install_os(path=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Installs the given image on the device. @@ -876,7 +876,7 @@ def junos_install_os(path=None, **kwargs): @proxy_napalm_wrap def junos_facts(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 The complete list of Junos facts collected by ``junos-eznc``. @@ -905,7 +905,7 @@ def junos_facts(**kwargs): @proxy_napalm_wrap def junos_cli(command, format=None, dev_timeout=None, dest=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Execute a CLI command and return the output in the specified format. @@ -942,7 +942,7 @@ def junos_cli(command, format=None, dev_timeout=None, dest=None, **kwargs): @proxy_napalm_wrap def junos_copy_file(src, dst, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Copies the file on the remote Junos device. @@ -969,7 +969,7 @@ def junos_copy_file(src, dst, **kwargs): @proxy_napalm_wrap def junos_call(fun, *args, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Execute an arbitrary function from the :mod:`junos execution module `. To check what ``args`` @@ -1010,7 +1010,7 @@ def junos_call(fun, *args, **kwargs): def pyeapi_nxos_api_args(**prev_kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return the key-value arguments used for the authentication arguments for the :mod:`pyeapi execution module `. @@ -1064,7 +1064,7 @@ def pyeapi_run_commands(*commands, **kwargs): @proxy_napalm_wrap def pyeapi_call(method, *args, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Invoke an arbitrary method from the ``pyeapi`` library. This function forwards the existing connection details to the @@ -1091,7 +1091,7 @@ def pyeapi_call(method, *args, **kwargs): @proxy_napalm_wrap def pyeapi_conn(**kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return the connection object with the Arista switch, over ``pyeapi``, passing the authentication details from the existing NAPALM connection. @@ -1122,7 +1122,7 @@ def pyeapi_config(commands=None, saltenv='base', **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Configures the Arista switch with the specified commands, via the ``pyeapi`` library. This function forwards the existing connection details to the @@ -1184,7 +1184,7 @@ def nxos_api_rpc(commands, method='cli', **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Execute an arbitrary RPC request via the Nexus API. @@ -1214,7 +1214,7 @@ def nxos_api_config(commands=None, saltenv='base', **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Configures the Nexus switch with the specified commands, via the NX-API. @@ -1272,7 +1272,7 @@ def nxos_api_config(commands=None, @proxy_napalm_wrap def nxos_api_show(commands, raw_text=True, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Execute one or more show (non-configuration) commands. @@ -1298,7 +1298,7 @@ def nxos_api_show(commands, raw_text=True, **kwargs): @proxy_napalm_wrap def rpc(command, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 This is a wrapper to execute RPC requests on various network operating systems supported by NAPALM, invoking the following functions for the NAPALM @@ -1355,7 +1355,7 @@ def rpc(command, **kwargs): @depends(HAS_CISCOCONFPARSE) def config_find_lines(regex, source='running'): r''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return the configuration lines that match the regular expressions from the ``regex`` argument. The configuration is read from the network device @@ -1382,7 +1382,7 @@ def config_find_lines(regex, source='running'): @depends(HAS_CISCOCONFPARSE) def config_lines_w_child(parent_regex, child_regex, source='running'): r''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return the configuration lines that match the regular expressions from the ``parent_regex`` argument, having child lines matching ``child_regex``. @@ -1421,7 +1421,7 @@ def config_lines_w_child(parent_regex, child_regex, source='running'): @depends(HAS_CISCOCONFPARSE) def config_lines_wo_child(parent_regex, child_regex, source='running'): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return the configuration lines that match the regular expressions from the ``parent_regex`` argument, having the child lines *not* matching @@ -1461,7 +1461,7 @@ def config_lines_wo_child(parent_regex, child_regex, source='running'): @depends(HAS_CISCOCONFPARSE) def config_filter_lines(parent_regex, child_regex, source='running'): r''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return a list of detailed matches, for the configuration blocks (parent-child relationship) whose parent respects the regular expressions configured via @@ -1507,7 +1507,7 @@ def config_filter_lines(parent_regex, child_regex, source='running'): def config_tree(source='running', with_tags=False): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Transform Cisco IOS style configuration to structured Python dictionary. Depending on the value of the ``with_tags`` argument, this function may @@ -1535,7 +1535,7 @@ def config_merge_tree(source='running', merge_path=None, saltenv='base'): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return the merge tree of the ``initial_config`` with the ``merge_config``, as a Python dictionary. @@ -1576,7 +1576,7 @@ def config_merge_text(source='running', merge_path=None, saltenv='base'): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return the merge result of the configuration from ``source`` with the merge configuration, as plain text (without loading the config on the @@ -1618,7 +1618,7 @@ def config_merge_diff(source='running', merge_path=None, saltenv='base'): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return the merge diff, as text, after merging the merge config into the configuration source requested (without loading the config on the device). @@ -1659,7 +1659,7 @@ def config_diff_tree(source1='candidate', source2='running', running_path=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return the diff, as Python dictionary, between two different sources. The sources can be either specified using the ``source1`` and ``source2`` @@ -1722,7 +1722,7 @@ def config_diff_text(source1='candidate', source2='running', running_path=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return the diff, as text, between the two different configuration sources. The sources can be either specified using the ``source1`` and ``source2`` @@ -1780,7 +1780,7 @@ def scp_get(remote_path, preserve_times=False, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Transfer files and directories from remote network device to the localhost of the Minion. @@ -1863,7 +1863,7 @@ def scp_put(files, saltenv='base', **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Transfer files and directories to remote network device. diff --git a/salt/modules/napalm_network.py b/salt/modules/napalm_network.py index e5611b3c172..42ff688d278 100644 --- a/salt/modules/napalm_network.py +++ b/salt/modules/napalm_network.py @@ -1378,7 +1378,7 @@ def load_config(filename=None, applies a manual configuration change, or a different process or command changes the configuration in the meanwhile). - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 commit_at: ``None`` Commit the changes at a specific time. Example of accepted formats: @@ -1402,7 +1402,7 @@ def load_config(filename=None, applies a manual configuration change, or a different process or command changes the configuration in the meanwhile). - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 revert_in: ``None`` Commit and revert the changes in a specific number of minutes / hours. @@ -1433,7 +1433,7 @@ def load_config(filename=None, commit and till the changes are reverted), these changes would be equally reverted, as Salt cannot be aware of them. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 revert_at: ``None`` Commit and revert the changes at a specific time. Example of accepted @@ -1463,7 +1463,7 @@ def load_config(filename=None, commit and till the changes are reverted), these changes would be equally reverted, as Salt cannot be aware of them. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 saltenv: ``base`` Specifies the Salt environment name. @@ -1616,7 +1616,7 @@ def load_template(template_name=None, - ``https:/example.com/template.mako`` - ``ftp://example.com/template.py`` - .. versionchanged:: Fluorine + .. versionchanged:: 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. @@ -1632,7 +1632,7 @@ def load_template(template_name=None, context: None Overrides default context variables passed to the template. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 template_hash_name: None When ``template_hash`` refers to a remote file, @@ -1707,7 +1707,7 @@ def load_template(template_name=None, applies a manual configuration change, or a different process or command changes the configuration in the meanwhile). - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 commit_at: ``None`` Commit the changes at a specific time. Example of accepted formats: @@ -1731,7 +1731,7 @@ def load_template(template_name=None, applies a manual configuration change, or a different process or command changes the configuration in the meanwhile). - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 revert_in: ``None`` Commit and revert the changes in a specific number of minutes / hours. @@ -1762,7 +1762,7 @@ def load_template(template_name=None, commit and till the changes are reverted), these changes would be equally reverted, as Salt cannot be aware of them. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 revert_at: ``None`` Commit and revert the changes at a specific time. Example of accepted @@ -1792,7 +1792,7 @@ def load_template(template_name=None, commit and till the changes are reverted), these changes would be equally reverted, as Salt cannot be aware of them. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 defaults: None Default variables/context passed to the template. @@ -2237,7 +2237,7 @@ def config_control(inherit_napalm_device=None, **kwargs): # pylint: disable=unu def cancel_commit(jid): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Cancel a commit scheduled to be executed via the ``commit_in`` and ``commit_at`` arguments from the @@ -2264,7 +2264,7 @@ def cancel_commit(jid): def confirm_commit(jid): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Confirm a commit scheduled to be reverted via the ``revert_in`` and ``revert_at`` arguments from the @@ -2294,7 +2294,7 @@ def confirm_commit(jid): def save_config(source=None, path=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Save the configuration to a file on the local file system. @@ -2348,7 +2348,7 @@ def replace_pattern(pattern, debug=False, commit=True): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Replace occurrences of a pattern in the configuration source. If ``show_changes`` is ``True``, then a diff of what changed will be returned, @@ -2487,7 +2487,7 @@ def blockreplace(marker_start, debug=False, replace=True): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Replace content of the configuration source, delimited by the line markers. @@ -2594,7 +2594,7 @@ def patch(patchfile, debug=False, replace=True): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Apply a patch to the configuration source, and load the result into the running config of the device. diff --git a/salt/modules/netbox.py b/salt/modules/netbox.py index 0c45cd230d2..141a274b677 100644 --- a/salt/modules/netbox.py +++ b/salt/modules/netbox.py @@ -196,7 +196,7 @@ def get_(app, endpoint, id=None, **kwargs): def create_manufacturer(name): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create a device manufacturer. @@ -223,7 +223,7 @@ def create_manufacturer(name): def create_device_type(model, manufacturer): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create a device type. If the manufacturer doesn't exist, create a new manufacturer. @@ -258,7 +258,7 @@ def create_device_type(model, manufacturer): def create_device_role(role, color): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create a device role @@ -285,7 +285,7 @@ def create_device_role(role, color): def create_platform(platform): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create a new device platform @@ -312,7 +312,7 @@ def create_platform(platform): def create_site(site): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create a new device site @@ -343,7 +343,7 @@ def create_device(name, manufacturer, site): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create a new device with a name, role, model, manufacturer and site. All these components need to be already in Netbox. @@ -393,7 +393,7 @@ def create_device(name, def update_device(name, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Add attributes to an existing device, identified by name. @@ -427,7 +427,7 @@ def create_inventory_item(device_name, part_id='', description=''): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Add an inventory item to an existing device. @@ -475,7 +475,7 @@ def create_inventory_item(device_name, def delete_inventory_item(item_id): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Remove an item from a devices inventory. Identified by the netbox id @@ -495,7 +495,7 @@ def delete_inventory_item(item_id): def create_interface_connection(interface_a, interface_b): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create an interface connection between 2 interfaces @@ -521,7 +521,7 @@ def create_interface_connection(interface_a, interface_b): def get_interfaces(device_name=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Returns interfaces for a specific device using arbitrary netbox filters @@ -548,7 +548,7 @@ def get_interfaces(device_name=None, **kwargs): def openconfig_interfaces(device_name=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return a dictionary structured as standardised in the `openconfig-interfaces `_ @@ -643,7 +643,7 @@ def openconfig_interfaces(device_name=None): def openconfig_lacp(device_name=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Return a dictionary structured as standardised in the `openconfig-lacp `_ @@ -706,7 +706,7 @@ def create_interface(device_name, lag_parent=None, form_factor=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Attach an interface to a device. If not all arguments are provided, they will default to Netbox defaults. @@ -768,7 +768,7 @@ def create_interface(device_name, def update_interface(device_name, interface_name, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Update an existing interface with new attributes. @@ -804,7 +804,7 @@ def update_interface(device_name, interface_name, **kwargs): def delete_interface(device_name, interface_name): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete an interface from a device. @@ -830,7 +830,7 @@ def delete_interface(device_name, interface_name): def make_interface_lag(device_name, interface_name): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Update an interface to be a LAG. @@ -851,7 +851,7 @@ def make_interface_lag(device_name, interface_name): def make_interface_child(device_name, interface_name, parent_name): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Set an interface as part of a LAG. @@ -880,7 +880,7 @@ def make_interface_child(device_name, interface_name, parent_name): def get_ipaddresses(device_name=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Filters for an IP address using specified filters @@ -906,7 +906,7 @@ def get_ipaddresses(device_name=None, **kwargs): def create_ipaddress(ip_address, family, device=None, interface=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Add an IP address, and optionally attach it to an interface. @@ -949,7 +949,7 @@ def create_ipaddress(ip_address, family, device=None, interface=None): def delete_ipaddress(ipaddr_id): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Delete an IP address. IP addresses in Netbox are a combination of address and the interface it is assigned to. @@ -973,7 +973,7 @@ def delete_ipaddress(ipaddr_id): def create_circuit_provider(name, asn=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create a new Netbox circuit provider @@ -1015,7 +1015,7 @@ def create_circuit_provider(name, asn=None): def get_circuit_provider(name, asn=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get a circuit provider with a given name and optional ASN. @@ -1039,7 +1039,7 @@ def get_circuit_provider(name, asn=None): def create_circuit_type(name): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create a new Netbox circuit type. @@ -1069,7 +1069,7 @@ def create_circuit_type(name): def create_circuit(name, provider_id, circuit_type, description=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Create a new Netbox circuit @@ -1115,7 +1115,7 @@ def create_circuit(name, provider_id, circuit_type, description=None): def create_circuit_termination(circuit, interface, device, speed, xconnect_id=None, term_side='A'): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Terminate a circuit on an interface diff --git a/salt/modules/netmiko_mod.py b/salt/modules/netmiko_mod.py index f8cf5db1db0..125e0e61cc8 100644 --- a/salt/modules/netmiko_mod.py +++ b/salt/modules/netmiko_mod.py @@ -3,7 +3,7 @@ Netmiko Execution Module ======================== -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 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 diff --git a/salt/modules/nxos_api.py b/salt/modules/nxos_api.py index 72b1ddfbada..0ce1863c629 100644 --- a/salt/modules/nxos_api.py +++ b/salt/modules/nxos_api.py @@ -2,7 +2,7 @@ ''' Execution module to manage Cisco Nexus Switches (NX-OS) over the NX-API -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Execution module used to interface the interaction with a remote or local Nexus switch whether we're running in a Proxy Minion or regular Minion (or regular diff --git a/salt/modules/openbsdpkg.py b/salt/modules/openbsdpkg.py index decceee1fc9..b3b6bab9120 100644 --- a/salt/modules/openbsdpkg.py +++ b/salt/modules/openbsdpkg.py @@ -348,7 +348,7 @@ def upgrade_available(name): ''' Check whether or not an upgrade is available for a given package - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -369,7 +369,7 @@ def upgrade(name=None, Returns a dictionary containing the changes: - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. code-block:: python diff --git a/salt/modules/opkg.py b/salt/modules/opkg.py index 412008f85f9..1c2135b6901 100644 --- a/salt/modules/opkg.py +++ b/salt/modules/opkg.py @@ -512,12 +512,12 @@ def remove(name=None, pkgs=None, **kwargs): # pylint: disable=unused-argument remove_dependencies Remove package and all dependencies - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 auto_remove_deps Remove packages that were installed automatically to satisfy dependencies - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Returns a dict containing the changes. diff --git a/salt/modules/peeringdb.py b/salt/modules/peeringdb.py index 06c910aef94..32b121be3fa 100644 --- a/salt/modules/peeringdb.py +++ b/salt/modules/peeringdb.py @@ -3,7 +3,7 @@ PeeringDB Module ================ -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Execution module for the basic interaction with the `PeeringDB `_ API. diff --git a/salt/modules/pf.py b/salt/modules/pf.py index 7bb495e140a..67acaf132a4 100644 --- a/salt/modules/pf.py +++ b/salt/modules/pf.py @@ -4,7 +4,7 @@ Control the OpenBSD packet filter (PF). :codeauthor: Jasper Lievisse Adriaanse -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 ''' from __future__ import absolute_import, print_function, unicode_literals diff --git a/salt/modules/pip.py b/salt/modules/pip.py index dd0d7a648db..eac40c719cf 100644 --- a/salt/modules/pip.py +++ b/salt/modules/pip.py @@ -1457,11 +1457,11 @@ def list_all_versions(pkg, index_url Base URL of Python Package Index - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 extra_index_url Additional URL of Python Package Index - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: diff --git a/salt/modules/postgres.py b/salt/modules/postgres.py index a18f75f4bdd..b6f7cbe5d49 100644 --- a/salt/modules/postgres.py +++ b/salt/modules/postgres.py @@ -3127,14 +3127,14 @@ def datadir_init(name, The transaction log (WAL) directory (default is to keep WAL inside the data directory) - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 checksums If True, the cluster will be created with data page checksums. .. note:: Data page checksums are supported since PostgreSQL 9.3. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 runas The system user the operation should be performed on behalf of diff --git a/salt/modules/purefb.py b/salt/modules/purefb.py index 91ec9bd659c..16a0ec5ca3c 100644 --- a/salt/modules/purefb.py +++ b/salt/modules/purefb.py @@ -47,7 +47,7 @@ Installation Prerequisites :requires: purestorage :platform: all -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 ''' @@ -170,7 +170,7 @@ def snap_create(name, suffix=None): Will return False if filesystem selected to snap does not exist. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 name : string name of filesystem to snapshot @@ -211,7 +211,7 @@ def snap_delete(name, suffix=None, eradicate=False): Will return False if selected snapshot does not exist. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 name : string name of filesystem @@ -255,7 +255,7 @@ def snap_eradicate(name, suffix=None): Will return False if snapshot is not in a deleted state. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 name : string name of filesystem @@ -288,7 +288,7 @@ def fs_create(name, size=None, proto='NFS', nfs_rules='*(rw,no_root_squash)', sn Will return False if filesystem already exists. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 name : string name of filesystem (truncated to 63 characters) @@ -360,7 +360,7 @@ def fs_delete(name, eradicate=False): Will return False if filesystem doesn't exist or is already in a deleted state. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 name : string name of filesystem @@ -404,7 +404,7 @@ def fs_eradicate(name): Will return False is filesystem is not in a deleted state. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 name : string name of filesystem @@ -434,7 +434,7 @@ def fs_extend(name, size): Will return False if new size is less than or equal to existing size. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 name : string name of filesystem @@ -475,7 +475,7 @@ def fs_update(name, rules, snapshot=False): Allows for change of NFS export rules and enabling/disabled of snapshotting capability. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 name : string name of filesystem diff --git a/salt/modules/saltutil.py b/salt/modules/saltutil.py index ef78a0e6a98..fe1c0f8fd25 100644 --- a/salt/modules/saltutil.py +++ b/salt/modules/saltutil.py @@ -549,7 +549,7 @@ def sync_proxymodules(saltenv=None, refresh=False, extmod_whitelist=None, extmod def sync_matchers(saltenv=None, refresh=False, extmod_whitelist=None, extmod_blacklist=None): ''' - .. versionadded:: Flourine + .. versionadded:: 2019.2.0 Sync engine modules from ``salt://_matchers`` to the minion @@ -777,7 +777,7 @@ def sync_utils(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blackli def sync_serializers(saltenv=None, refresh=True, extmod_whitelist=None, extmod_blacklist=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Sync serializers from ``salt://_serializers`` to the minion diff --git a/salt/modules/scp_mod.py b/salt/modules/scp_mod.py index 4f8e4f7182e..c8cf7eb68e7 100644 --- a/salt/modules/scp_mod.py +++ b/salt/modules/scp_mod.py @@ -3,7 +3,7 @@ SCP Module ========== -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Module to copy files via `SCP `_ ''' diff --git a/salt/modules/selinux.py b/salt/modules/selinux.py index 8c08c83b460..ac469df36e4 100644 --- a/salt/modules/selinux.py +++ b/salt/modules/selinux.py @@ -390,7 +390,7 @@ def _validate_filetype(filetype): def _parse_protocol_port(name, protocol, port): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Validates and parses the protocol and port/port range from the name if both protocol and port are not provided. @@ -505,7 +505,7 @@ def fcontext_get_policy(name, filetype=None, sel_type=None, sel_user=None, sel_l def fcontext_add_policy(name, filetype=None, sel_type=None, sel_user=None, sel_level=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Adds the SELinux policy for a given filespec and other optional parameters. @@ -544,7 +544,7 @@ def fcontext_add_policy(name, filetype=None, sel_type=None, sel_user=None, sel_l def fcontext_delete_policy(name, filetype=None, sel_type=None, sel_user=None, sel_level=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Deletes the SELinux policy for a given filespec and other optional parameters. @@ -598,7 +598,7 @@ def fcontext_add_or_delete_policy(action, name, filetype=None, sel_type=None, se Use :mod:`selinux.fcontext_add_policy()`, or :mod:`selinux.fcontext_delete_policy()`. - .. deprecated:: Fluorine + .. deprecated:: 2019.2.0 action The action to perform. Either ``add`` or ``delete``. @@ -639,7 +639,7 @@ def fcontext_add_or_delete_policy(action, name, filetype=None, sel_type=None, se def _fcontext_add_or_delete_policy(action, name, filetype=None, sel_type=None, sel_user=None, sel_level=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Performs the action as called from ``fcontext_add_policy`` or ``fcontext_delete_policy``. @@ -736,7 +736,7 @@ def fcontext_apply_policy(name, recursive=False): def port_get_policy(name, sel_type=None, protocol=None, port=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Returns the current entry in the SELinux policy list as a dictionary. Returns None if no exact match was found. @@ -788,7 +788,7 @@ def port_get_policy(name, sel_type=None, protocol=None, port=None): def port_add_policy(name, sel_type=None, protocol=None, port=None, sel_range=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Adds the SELinux policy for a given protocol and port. @@ -821,7 +821,7 @@ def port_add_policy(name, sel_type=None, protocol=None, port=None, sel_range=Non def port_delete_policy(name, protocol=None, port=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Deletes the SELinux policy for a given protocol and port. @@ -848,7 +848,7 @@ def port_delete_policy(name, protocol=None, port=None): def _port_add_or_delete_policy(action, name, sel_type=None, protocol=None, port=None, sel_range=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Performs the action as called from ``port_add_policy`` or ``port_delete_policy``. diff --git a/salt/modules/slsutil.py b/salt/modules/slsutil.py index 2fadfc73ffd..a549594a18e 100644 --- a/salt/modules/slsutil.py +++ b/salt/modules/slsutil.py @@ -56,7 +56,7 @@ def merge(obj_a, obj_b, strategy='smart', renderer='yaml', merge_lists=False): def merge_all(lst, strategy='smart', renderer='yaml', merge_lists=False): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Merge a list of objects into each other in order diff --git a/salt/modules/smartos_imgadm.py b/salt/modules/smartos_imgadm.py index d6fc5873e08..7cc76e53562 100644 --- a/salt/modules/smartos_imgadm.py +++ b/salt/modules/smartos_imgadm.py @@ -157,7 +157,7 @@ def docker_to_uuid(uuid): ''' Get the image uuid from an imported docker image - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 ''' if _is_uuid(uuid): return uuid @@ -232,7 +232,7 @@ def list_installed(verbose=False): verbose : boolean (False) toggle verbose output - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 Docker images are now also listed @@ -422,7 +422,7 @@ def sources(verbose=False): verbose : boolean (False) toggle verbose output - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -455,7 +455,7 @@ def source_delete(source): source : string source url to delete - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -483,7 +483,7 @@ def source_add(source, source_type='imgapi'): source_trype : string (imgapi) source type, either imgapi or docker - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: diff --git a/salt/modules/solarisips.py b/salt/modules/solarisips.py index 5f6729296c1..34f9d9a4024 100644 --- a/salt/modules/solarisips.py +++ b/salt/modules/solarisips.py @@ -338,7 +338,7 @@ def latest_version(*names, **kwargs): Please use pkg.latest_version as pkg.available_version is being deprecated. - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 Support for multiple package names added. CLI Example: diff --git a/salt/modules/state.py b/salt/modules/state.py index cf66ee0a33c..a594a2b0967 100644 --- a/salt/modules/state.py +++ b/salt/modules/state.py @@ -772,7 +772,7 @@ def apply_(mods=None, **kwargs): :ref:`highstate ` automatically syncs all custom module types. - .. versionadded:: 2017.7.8,2018.3.3,Fluorine + .. versionadded:: 2017.7.8,2018.3.3,2019.2.0 ''' if mods: return sls(mods, **kwargs) @@ -1199,7 +1199,7 @@ def sls(mods, test=None, exclude=None, queue=False, sync_mods=None, **kwargs): salt '*' state.sls stuff sync_mods=states,modules salt '*' state.sls stuff sync_mods=all - .. versionadded:: 2017.7.8,2018.3.3,Fluorine + .. versionadded:: 2017.7.8,2018.3.3,2019.2.0 CLI Example: @@ -1603,7 +1603,7 @@ def show_states(queue=False, **kwargs): salt '*' state.show_states - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 ''' conflict = _check_queue(queue, kwargs) @@ -1945,7 +1945,7 @@ def sls_exists(mods, test=None, queue=False, **kwargs): rather than returning state details, returns True or False. The default environment is ``base``, use ``saltenv`` to specify a different environment. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 saltenv Specify a salt fileserver environment from which to look for the SLS files @@ -1970,7 +1970,7 @@ def id_exists(ids, mods, test=None, queue=False, **kwargs): `, returns True or False. The default environment is base``, use ``saltenv`` to specify a different environment. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 saltenv Specify a salt fileserver environment from which to look for the SLS files @@ -2362,7 +2362,7 @@ def event(tagmatch='*', Watch Salt's event bus and block until the given tag is matched .. versionadded:: 2016.3.0 - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 ``tagmatch`` can now be either a glob or regular expression. This is useful for utilizing Salt's event bus from shell scripts or for diff --git a/salt/modules/tls.py b/salt/modules/tls.py index 191300fcb05..c9352c775bb 100644 --- a/salt/modules/tls.py +++ b/salt/modules/tls.py @@ -585,7 +585,7 @@ def _get_expiration_date(cert): def get_expiration_date(cert, date_format='%Y-%m-%d'): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Get a certificate's expiration date diff --git a/salt/modules/virt.py b/salt/modules/virt.py index bb8f661e42b..b45c5f522d8 100644 --- a/salt/modules/virt.py +++ b/salt/modules/virt.py @@ -45,7 +45,7 @@ the remote libvirt machine. Per call connection setup ------------------------- -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 All the calls requiring the libvirt connection configuration as mentioned above can override this configuration using ``connection``, ``username`` and ``password`` parameters. @@ -1162,7 +1162,7 @@ def init(name, These data are merged with the ones from the nic profile. The structure of each dictionary is documented in :ref:`init-nic-def`. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param hypervisor: the virtual machine type. By default the value will be computed according to the virtual host capabilities. :param start: ``True`` to start the virtual machine after having defined it (Default: ``True``) @@ -1171,7 +1171,7 @@ def init(name, These data are merged with the ones from the disk profile. The structure of each dictionary is documented in :ref:`init-disk-def`. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param saltenv: Fileserver environment (Default: ``'base'``). See :mod:`cp module for more details ` :param seed: ``True`` to seed the disk image. Only used when the ``image`` parameter is provided. @@ -1190,22 +1190,22 @@ def init(name, graphics={'type': 'vnc'} - .. deprecated:: Fluorine + .. deprecated:: 2019.2.0 :param graphics: Dictionary providing details on the graphics device to create. (Default: ``None``) See :ref:`init-graphics-def` for more details on the possible values. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param os_type: type of virtualization as found in the ``//os/type`` element of the libvirt definition. The default value is taken from the host capabilities, with a preference for ``hvm``. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param arch: architecture of the virtual machine. The default value is taken from the host capabilities, but ``x86_64`` is prefed over ``i686``. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param enable_qcow: ``True`` to create a QCOW2 overlay image, rather than copying the image (Default: ``False``). @@ -1221,7 +1221,7 @@ def init(name, 'overlay_image': True } - .. deprecated:: Fluorine + .. deprecated:: 2019.2.0 :param pool: Path of the folder where the image files are located for vmware/esx hypervisors. @@ -1250,7 +1250,7 @@ def init(name, 'mac': 'MY:MA:CC:ADD:RE:SS' } - .. deprecated:: Fluorine + .. deprecated:: 2019.2.0 :param config: minion configuration to use when seeding. See :mod:`seed module for more details ` :param boot_dev: String of space-separated devices to boot from (Default: ``'hd'``) @@ -1259,13 +1259,13 @@ def init(name, :param console: ``True`` to add a console device along with serial one (Default: ``True``) :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. _init-nic-def: @@ -1745,7 +1745,7 @@ def update(name, 'errors': ['error messages for failures'] } - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -1878,13 +1878,13 @@ def list_domains(**kwargs): :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -1906,13 +1906,13 @@ def list_active_vms(**kwargs): :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -1934,13 +1934,13 @@ def list_inactive_vms(**kwargs): :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -1964,13 +1964,13 @@ def vm_info(vm_=None, **kwargs): :param vm_: name of the domain :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. code-block:: python @@ -2032,13 +2032,13 @@ def vm_state(vm_=None, **kwargs): :param vm_: name of the domain :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2087,13 +2087,13 @@ def node_info(**kwargs): :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2114,13 +2114,13 @@ def get_nics(vm_, **kwargs): :param vm_: name of the domain :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2141,13 +2141,13 @@ def get_macs(vm_, **kwargs): :param vm_: name of the domain :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2166,13 +2166,13 @@ def get_graphics(vm_, **kwargs): :param vm_: name of the domain :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2193,13 +2193,13 @@ def get_disks(vm_, **kwargs): :param vm_: name of the domain :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2223,13 +2223,13 @@ def setmem(vm_, memory, config=False, **kwargs): :param config: if True then libvirt will be asked to modify the config as well :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2272,13 +2272,13 @@ def setvcpus(vm_, vcpus, config=False, **kwargs): :param config: if True then libvirt will be asked to modify the config as well :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2326,13 +2326,13 @@ def freemem(**kwargs): :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2364,13 +2364,13 @@ def freecpu(**kwargs): :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2390,13 +2390,13 @@ def full_info(**kwargs): :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2420,13 +2420,13 @@ def get_xml(vm_, **kwargs): :param vm_: domain name :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2452,13 +2452,13 @@ def get_profiles(hypervisor=None, **kwargs): :param hypervisor: override the default machine type. :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2505,13 +2505,13 @@ def shutdown(vm_, **kwargs): :param vm_: domain name :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2533,13 +2533,13 @@ def pause(vm_, **kwargs): :param vm_: domain name :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2561,13 +2561,13 @@ def resume(vm_, **kwargs): :param vm_: domain name :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2589,13 +2589,13 @@ def start(name, **kwargs): :param vm_: domain name :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2616,13 +2616,13 @@ def stop(name, **kwargs): :param vm_: domain name :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2643,13 +2643,13 @@ def reboot(name, **kwargs): :param vm_: domain name :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2670,13 +2670,13 @@ def reset(vm_, **kwargs): :param vm_: domain name :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2702,13 +2702,13 @@ def ctrl_alt_del(vm_, **kwargs): :param vm_: domain name :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2730,13 +2730,13 @@ def create_xml_str(xml, **kwargs): # pylint: disable=redefined-outer-name :param xml: libvirt XML definition of the domain :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2757,13 +2757,13 @@ def create_xml_path(path, **kwargs): :param path: path to a file containing the libvirt XML definition of the domain :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2788,13 +2788,13 @@ def define_xml_str(xml, **kwargs): # pylint: disable=redefined-outer-name :param xml: libvirt XML definition of the domain :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2815,13 +2815,13 @@ def define_xml_path(path, **kwargs): :param path: path to a file containing the libvirt XML definition of the domain :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2847,13 +2847,13 @@ def define_vol_xml_str(xml, **kwargs): # pylint: disable=redefined-outer-name :param xml: libvirt XML definition of the storage volume :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -2894,13 +2894,13 @@ def define_vol_xml_path(path, **kwargs): :param path: path to a file containing the libvirt XML definition of the volume :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -3071,13 +3071,13 @@ def set_autostart(vm_, state='on', **kwargs): pool not to be started when the host boots :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -3109,13 +3109,13 @@ def undefine(vm_, **kwargs): :param vm_: domain name :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -3148,16 +3148,16 @@ def purge(vm_, dirs=False, removables=None, **kwargs): :param dirs: pass True to remove containing directories :param removables: pass True to remove removable devices - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -3233,7 +3233,7 @@ def is_kvm_hyper(): salt '*' virt.is_kvm_hyper - .. deprecated:: Fluorine + .. deprecated:: 2019.2.0 ''' salt.utils.versions.warn_until( 'Sodium', @@ -3273,7 +3273,7 @@ def is_xen_hyper(): salt '*' virt.is_xen_hyper - .. deprecated:: Fluorine + .. deprecated:: 2019.2.0 ''' salt.utils.versions.warn_until( 'Sodium', @@ -3298,7 +3298,7 @@ def get_hypervisor(): salt '*' virt.get_hypervisor - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 the function and the ``kvm`` and ``xen`` hypervisors support ''' # To add a new 'foo' hypervisor, add the _is_foo_hyper function, @@ -3331,13 +3331,13 @@ def vm_cputime(vm_=None, **kwargs): :param vm_: domain name :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. code-block:: python @@ -3394,13 +3394,13 @@ def vm_netstats(vm_=None, **kwargs): :param vm_: domain name :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. code-block:: python @@ -3475,13 +3475,13 @@ def vm_diskstats(vm_=None, **kwargs): :param vm_: domain name :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. code-block:: python @@ -3576,13 +3576,13 @@ def list_snapshots(domain=None, **kwargs): :param domain: domain name :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. versionadded:: 2016.3.0 @@ -3614,13 +3614,13 @@ def snapshot(domain, name=None, suffix=None, **kwargs): can be distinguished from manually created. :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. versionadded:: 2016.3.0 @@ -3660,13 +3660,13 @@ def delete_snapshots(name, *names, **kwargs): :param names: names of the snapshots to remove :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. versionadded:: 2016.3.0 @@ -3701,13 +3701,13 @@ def revert_snapshot(name, vm_snapshot=None, cleanup=False, **kwargs): :param cleanup: Remove all newer than reverted snapshots. Values: True or False (default False). :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. versionadded:: 2016.3.0 @@ -3992,7 +3992,7 @@ def capabilities(**kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4098,7 +4098,7 @@ def domain_capabilities(emulator=None, arch=None, machine=None, domain=None, **k ''' Return the domain capabilities given an emulator, architecture, machine or virtualization type. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param emulator: return the capabilities for the given emulator binary :param arch: return the capabilities for the given CPU architecture @@ -4175,13 +4175,13 @@ def cpu_baseline(full=False, migratable=False, out='libvirt', **kwargs): :param out: 'libvirt' (default) for usable libvirt XML definition, 'salt' for nice dict :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4269,7 +4269,7 @@ def network_define(name, bridge, forward, **kwargs): salt '*' virt.network_define network main bridge openvswitch - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 ''' conn = __get_conn(**kwargs) vport = kwargs.get('vport', None) @@ -4322,7 +4322,7 @@ def list_networks(**kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4348,7 +4348,7 @@ def network_info(name=None, **kwargs): If no name is provided, return the infos for all defined virtual networks. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4398,7 +4398,7 @@ def network_start(name, **kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4423,7 +4423,7 @@ def network_stop(name, **kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4448,7 +4448,7 @@ def network_undefine(name, **kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4476,7 +4476,7 @@ def network_set_autostart(name, state='on', **kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4623,7 +4623,7 @@ def pool_define(name, salt '*' virt.pool_define myshare netfs source_format=cifs \ source_dir=samba_share source_hosts="['example.com']" target=/mnt/cifs - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 ''' conn = __get_conn(**kwargs) pool_xml = _gen_pool_xml( @@ -4663,7 +4663,7 @@ def list_pools(**kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4689,7 +4689,7 @@ def pool_info(name=None, **kwargs): If no name is provided, return the infos for all defined storage pools. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4742,7 +4742,7 @@ def pool_start(name, **kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4767,7 +4767,7 @@ def pool_build(name, **kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4792,7 +4792,7 @@ def pool_stop(name, **kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4817,7 +4817,7 @@ def pool_undefine(name, **kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4844,7 +4844,7 @@ def pool_delete(name, fast=True, **kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4872,7 +4872,7 @@ def pool_refresh(name, **kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4900,7 +4900,7 @@ def pool_set_autostart(name, state='on', **kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -4925,7 +4925,7 @@ def pool_list_volumes(name, **kwargs): :param username: username to connect with, overriding defaults :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: diff --git a/salt/modules/vmctl.py b/salt/modules/vmctl.py index 8efed524ada..94be39c329d 100644 --- a/salt/modules/vmctl.py +++ b/salt/modules/vmctl.py @@ -2,7 +2,7 @@ ''' Manage vms running on the OpenBSD VMM hypervisor using vmctl(8). -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 :codeauthor: ``Jasper Lievisse Adriaanse `` diff --git a/salt/modules/win_firewall.py b/salt/modules/win_firewall.py index fb635288859..2a721df2325 100644 --- a/salt/modules/win_firewall.py +++ b/salt/modules/win_firewall.py @@ -351,7 +351,7 @@ def get_settings(profile, section, store='local'): as returned by ``netsh advfirewall``. .. versionadded:: 2018.3.4 - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Args: @@ -409,7 +409,7 @@ def get_all_settings(domain, store='local'): Gets all the properties for the specified profile in the specified store .. versionadded:: 2018.3.4 - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Args: @@ -452,7 +452,7 @@ def get_all_profiles(store='local'): Gets all properties for all profiles in the specified store .. versionadded:: 2018.3.4 - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Args: @@ -489,7 +489,7 @@ def set_firewall_settings(profile, inbound=None, outbound=None, store='local'): store .. versionadded:: 2018.3.4 - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Args: @@ -564,7 +564,7 @@ def set_logging_settings(profile, setting, value, store='local'): Configure logging settings for the Windows firewall. .. versionadded:: 2018.3.4 - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Args: @@ -658,7 +658,7 @@ def set_settings(profile, setting, value, store='local'): Configure firewall settings. .. versionadded:: 2018.3.4 - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Args: @@ -725,7 +725,7 @@ def set_state(profile, state, store='local'): Configure the firewall state. .. versionadded:: 2018.3.4 - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Args: diff --git a/salt/modules/win_network.py b/salt/modules/win_network.py index 0f0c0fae4d7..d8b6db960e7 100644 --- a/salt/modules/win_network.py +++ b/salt/modules/win_network.py @@ -363,13 +363,13 @@ def ip_addrs(interface=None, include_loopback=False, cidr=None, type=None): Describes subnet using CIDR notation and only IPv4 addresses that belong to this subnet will be returned. - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 type If option set to 'public' then only public addresses will be returned. Ditto for 'private'. - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 CLI Example: @@ -409,7 +409,7 @@ def ip_addrs6(interface=None, include_loopback=False, cidr=None): Describes subnet using CIDR notation and only IPv6 addresses that belong to this subnet will be returned. - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 CLI Example: @@ -525,7 +525,7 @@ def is_private(ip_addr): ''' Check if the given IP address is a private address - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: diff --git a/salt/modules/yumpkg.py b/salt/modules/yumpkg.py index 51563a312c3..c250b94f0ec 100644 --- a/salt/modules/yumpkg.py +++ b/salt/modules/yumpkg.py @@ -812,7 +812,7 @@ def list_repo_pkgs(*args, **kwargs): be expanded and ``--setopt`` prepended to each in the yum/dnf command that is run. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Examples: @@ -1084,7 +1084,7 @@ def refresh_db(**kwargs): be expanded and ``--setopt`` prepended to each in the yum/dnf command that is run. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 CLI Example: @@ -1249,7 +1249,7 @@ def install(name=None, salt '*' pkg.install foo setopt='obsoletes=0,plugins=0' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Repository Options: @@ -1745,7 +1745,7 @@ def upgrade(name=None, .. _`systemd-run(1)`: https://www.freedesktop.org/software/systemd/man/systemd-run.html .. _`systemd.kill(5)`: https://www.freedesktop.org/software/systemd/man/systemd.kill.html - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 Added ``obsoletes`` and ``minimal`` arguments Returns a dictionary containing the changes: @@ -1838,7 +1838,7 @@ def upgrade(name=None, salt '*' pkg.upgrade minimal=True - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 obsoletes : True Controls wether yum/dnf should take obsoletes into account and remove them. @@ -1849,14 +1849,14 @@ def upgrade(name=None, salt '*' pkg.upgrade obsoletes=False - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 setopt A comma-separated or Python list of key=value options. This list will be expanded and ``--setopt`` prepended to each in the yum/dnf command that is run. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. note:: To add extra arguments to the ``yum upgrade`` command, pass them as key @@ -1929,7 +1929,7 @@ def update(name=None, obsoletes=False, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Calls :py:func:`pkg.upgrade ` with ``obsoletes=False``. Mirrors the CLI behavior of ``yum update``. diff --git a/salt/modules/zabbix.py b/salt/modules/zabbix.py index 221d2ca8a05..7cf0a55e039 100644 --- a/salt/modules/zabbix.py +++ b/salt/modules/zabbix.py @@ -1323,7 +1323,7 @@ def host_inventory_get(hostids, **connection_args): Retrieve host inventory according to the given parameters. See: https://www.zabbix.com/documentation/2.4/manual/api/reference/host/object#host_inventory - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param hostids: Return only host interfaces used by the given hosts. :param _connection_user: Optional - zabbix user (can also be set in opts or pillar, see module's docstring) @@ -1360,7 +1360,7 @@ def host_inventory_set(hostid, **connection_args): NOTE: This function accepts all standard host: keyword argument names for inventory see: https://www.zabbix.com/documentation/2.4/manual/api/reference/host/object#host_inventory - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param hostid: ID of the host to update :param clear_old: Set to True in order to remove all existing inventory items before setting the specified items diff --git a/salt/modules/zfs.py b/salt/modules/zfs.py index 6f6aa04a64b..151e5e1aefa 100644 --- a/salt/modules/zfs.py +++ b/salt/modules/zfs.py @@ -451,7 +451,7 @@ def mount(name=None, **kwargs): if name == '-a': salt.utils.versions.warn_until( 'Sodium', - 'Passing \'-a\' as name is deprecated as of Salt Fluorine. This ' + 'Passing \'-a\' as name is deprecated as of Salt 2019.2.0. This ' 'warning will be removed in Salt Sodium. Please pass name as ' '\'None\' instead to mount all filesystems.') flags.append('-a') diff --git a/salt/pillar/netbox.py b/salt/pillar/netbox.py index 71d99b3bba9..65807e610a0 100644 --- a/salt/pillar/netbox.py +++ b/salt/pillar/netbox.py @@ -2,7 +2,7 @@ ''' A module that adds data to the Pillar structure from a NetBox API. -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Configuring the NetBox ext_pillar --------------------------------- diff --git a/salt/proxy/arista_pyeapi.py b/salt/proxy/arista_pyeapi.py index b3c5017515b..860676b2305 100644 --- a/salt/proxy/arista_pyeapi.py +++ b/salt/proxy/arista_pyeapi.py @@ -3,7 +3,7 @@ Arista pyeapi ============= -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Proxy module for managing Arista switches via the eAPI using the `pyeapi `_ library. diff --git a/salt/proxy/docker.py b/salt/proxy/docker.py index 593785bb585..c70f8f52377 100644 --- a/salt/proxy/docker.py +++ b/salt/proxy/docker.py @@ -2,7 +2,7 @@ ''' Docker Proxy Minion -.. versionadded: Fluorine +.. versionadded: 2019.2.0 :depends: docker diff --git a/salt/proxy/napalm.py b/salt/proxy/napalm.py index 4111df9ccba..91f4fc4c495 100644 --- a/salt/proxy/napalm.py +++ b/salt/proxy/napalm.py @@ -135,7 +135,7 @@ Example using a user-specific library, extending NAPALM's capabilities, e.g. ``c - :mod:`Users configuration management ` .. note:: - Beginning with release codename Fluorine, any NAPALM command executed when + Beginning with release codename 2019.2.0, any NAPALM command executed when running under a NAPALM Proxy Minion supports the ``force_reconnect`` magic argument. diff --git a/salt/proxy/netmiko_px.py b/salt/proxy/netmiko_px.py index e9ac1809c74..b85e7482292 100644 --- a/salt/proxy/netmiko_px.py +++ b/salt/proxy/netmiko_px.py @@ -3,7 +3,7 @@ Netmiko ======= -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Proxy module for managing network devices via `Netmiko `_. diff --git a/salt/proxy/nxos_api.py b/salt/proxy/nxos_api.py index 9a09cc8b549..1d7eefb520e 100644 --- a/salt/proxy/nxos_api.py +++ b/salt/proxy/nxos_api.py @@ -2,7 +2,7 @@ ''' Proxy Minion to manage Cisco Nexus Switches (NX-OS) over the NX-API -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Proxy module for managing Cisco Nexus switches via the NX-API. diff --git a/salt/returners/pgjsonb.py b/salt/returners/pgjsonb.py index 33b1bd7fd62..04f2af58c05 100644 --- a/salt/returners/pgjsonb.py +++ b/salt/returners/pgjsonb.py @@ -73,7 +73,7 @@ set ``archive_jobs`` to True. Salt will create 3 archive tables; and move the contents of ``jids``, ``salt_returns``, and ``salt_events`` that are more than ``keep_jobs`` hours old to these tables. -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 Use the following Pg database schema: diff --git a/salt/runners/manage.py b/salt/runners/manage.py index 34a7d20b4e3..e89f41328a6 100644 --- a/salt/runners/manage.py +++ b/salt/runners/manage.py @@ -221,7 +221,7 @@ def _show_ip_migration(show_ip, show_ipv4): def list_state(subset=None, show_ip=False, show_ipv4=None, state=None): ''' .. versionadded:: 2015.8.0 - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. @@ -271,7 +271,7 @@ def list_state(subset=None, show_ip=False, show_ipv4=None, state=None): def list_not_state(subset=None, show_ip=False, show_ipv4=None, state=None): ''' .. versionadded:: 2015.8.0 - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. @@ -317,7 +317,7 @@ def list_not_state(subset=None, show_ip=False, show_ipv4=None, state=None): def present(subset=None, show_ip=False, show_ipv4=None): ''' - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. @@ -343,7 +343,7 @@ def present(subset=None, show_ip=False, show_ipv4=None): def not_present(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.5.0 - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. @@ -369,7 +369,7 @@ def not_present(subset=None, show_ip=False, show_ipv4=None): def joined(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. @@ -395,7 +395,7 @@ def joined(subset=None, show_ip=False, show_ipv4=None): def not_joined(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. @@ -421,7 +421,7 @@ def not_joined(subset=None, show_ip=False, show_ipv4=None): def allowed(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. @@ -447,7 +447,7 @@ def allowed(subset=None, show_ip=False, show_ipv4=None): def not_allowed(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. @@ -473,7 +473,7 @@ def not_allowed(subset=None, show_ip=False, show_ipv4=None): def alived(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. @@ -499,7 +499,7 @@ def alived(subset=None, show_ip=False, show_ipv4=None): def not_alived(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. @@ -525,7 +525,7 @@ def not_alived(subset=None, show_ip=False, show_ipv4=None): def reaped(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. @@ -551,7 +551,7 @@ def reaped(subset=None, show_ip=False, show_ipv4=None): def not_reaped(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. diff --git a/salt/runners/saltutil.py b/salt/runners/saltutil.py index b61aa2bef69..6f6af53dea3 100644 --- a/salt/runners/saltutil.py +++ b/salt/runners/saltutil.py @@ -585,7 +585,7 @@ def sync_eauth_tokens(saltenv='base', extmod_whitelist=None, extmod_blacklist=No def sync_serializers(saltenv='base', extmod_whitelist=None, extmod_blacklist=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Sync serializer modules from ``salt://_serializers`` to the master diff --git a/salt/runners/state.py b/salt/runners/state.py index 2d9d8353d82..1a9389b38ba 100644 --- a/salt/runners/state.py +++ b/salt/runners/state.py @@ -258,7 +258,7 @@ def event(tagmatch='*', Watch Salt's event bus and block until the given tag is matched .. versionadded:: 2014.7.0 - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 ``tagmatch`` can now be either a glob or regular expression. This is useful for utilizing Salt's event bus from shell scripts or for diff --git a/salt/sdb/redis_sdb.py b/salt/sdb/redis_sdb.py index 182b162d8e5..fe45faf9b5e 100644 --- a/salt/sdb/redis_sdb.py +++ b/salt/sdb/redis_sdb.py @@ -3,7 +3,7 @@ Redis SDB module ================ - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 This module allows access to Redis using an ``sdb://`` URI. diff --git a/salt/states/azurearm_compute.py b/salt/states/azurearm_compute.py index 29596cd469c..c67e6b940ba 100644 --- a/salt/states/azurearm_compute.py +++ b/salt/states/azurearm_compute.py @@ -2,7 +2,7 @@ ''' Azure (ARM) Compute State Module -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 :maintainer: :maturity: new @@ -105,7 +105,7 @@ def availability_set_present(name, resource_group, tags=None, platform_update_do platform_fault_domain_count=None, virtual_machines=None, sku=None, connection_auth=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure an availability set exists. @@ -265,7 +265,7 @@ def availability_set_present(name, resource_group, tags=None, platform_update_do def availability_set_absent(name, resource_group, connection_auth=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure an availability set does not exist in a resource group. diff --git a/salt/states/azurearm_network.py b/salt/states/azurearm_network.py index e7f3ef48dc8..58efcae72b0 100644 --- a/salt/states/azurearm_network.py +++ b/salt/states/azurearm_network.py @@ -2,7 +2,7 @@ ''' Azure (ARM) Network State Module -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 :maintainer: :maturity: new @@ -112,7 +112,7 @@ def __virtual__(): def virtual_network_present(name, address_prefixes, resource_group, dns_servers=None, tags=None, connection_auth=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a virtual network exists. @@ -260,7 +260,7 @@ def virtual_network_present(name, address_prefixes, resource_group, dns_servers= def virtual_network_absent(name, resource_group, connection_auth=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a virtual network does not exist in the resource group. @@ -324,7 +324,7 @@ def virtual_network_absent(name, resource_group, connection_auth=None): def subnet_present(name, address_prefix, virtual_network, resource_group, security_group=None, route_table=None, connection_auth=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a subnet exists. @@ -465,7 +465,7 @@ def subnet_present(name, address_prefix, virtual_network, resource_group, def subnet_absent(name, virtual_network, resource_group, connection_auth=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a virtual network does not exist in the virtual network. @@ -533,7 +533,7 @@ def subnet_absent(name, virtual_network, resource_group, connection_auth=None): def network_security_group_present(name, resource_group, tags=None, security_rules=None, connection_auth=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a network security group exists. @@ -673,7 +673,7 @@ def network_security_group_present(name, resource_group, tags=None, security_rul def network_security_group_absent(name, resource_group, connection_auth=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a network security group does not exist in the resource group. @@ -740,7 +740,7 @@ def security_rule_present(name, access, direction, priority, protocol, security_ destination_port_ranges=None, source_address_prefixes=None, source_port_ranges=None, connection_auth=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a security rule exists. @@ -1054,7 +1054,7 @@ def security_rule_present(name, access, direction, priority, protocol, security_ def security_rule_absent(name, security_group, resource_group, connection_auth=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a security rule does not exist in the network security group. @@ -1123,7 +1123,7 @@ def load_balancer_present(name, resource_group, sku=None, frontend_ip_configurat load_balancing_rules=None, probes=None, inbound_nat_rules=None, inbound_nat_pools=None, outbound_nat_rules=None, tags=None, connection_auth=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a load balancer exists. @@ -1480,7 +1480,7 @@ def load_balancer_present(name, resource_group, sku=None, frontend_ip_configurat def load_balancer_absent(name, resource_group, connection_auth=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a load balancer does not exist in the resource group. @@ -1545,7 +1545,7 @@ def public_ip_address_present(name, resource_group, tags=None, sku=None, public_ public_ip_address_version=None, dns_settings=None, idle_timeout_in_minutes=None, connection_auth=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a public IP address exists. @@ -1729,7 +1729,7 @@ def public_ip_address_present(name, resource_group, tags=None, sku=None, public_ def public_ip_address_absent(name, resource_group, connection_auth=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a public IP address does not exist in the resource group. @@ -1795,7 +1795,7 @@ def network_interface_present(name, ip_configurations, subnet, virtual_network, primary=None, enable_accelerated_networking=None, enable_ip_forwarding=None, connection_auth=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a network interface exists. @@ -2049,7 +2049,7 @@ def network_interface_present(name, ip_configurations, subnet, virtual_network, def network_interface_absent(name, resource_group, connection_auth=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a network interface does not exist in the resource group. @@ -2113,7 +2113,7 @@ def network_interface_absent(name, resource_group, connection_auth=None): def route_table_present(name, resource_group, tags=None, routes=None, disable_bgp_route_propagation=None, connection_auth=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a route table exists. @@ -2253,7 +2253,7 @@ def route_table_present(name, resource_group, tags=None, routes=None, disable_bg def route_table_absent(name, resource_group, connection_auth=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a route table does not exist in the resource group. @@ -2317,7 +2317,7 @@ def route_table_absent(name, resource_group, connection_auth=None): def route_present(name, address_prefix, next_hop_type, route_table, resource_group, next_hop_ip_address=None, connection_auth=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a route exists within a route table. @@ -2449,7 +2449,7 @@ def route_present(name, address_prefix, next_hop_type, route_table, resource_gro def route_absent(name, route_table, resource_group, connection_auth=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a route table does not exist in the resource group. diff --git a/salt/states/azurearm_resource.py b/salt/states/azurearm_resource.py index 79f124b5dae..3fb730f4e09 100644 --- a/salt/states/azurearm_resource.py +++ b/salt/states/azurearm_resource.py @@ -2,7 +2,7 @@ ''' Azure (ARM) Resource State Module -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 :maintainer: :maturity: new @@ -103,7 +103,7 @@ def __virtual__(): def resource_group_present(name, location, managed_by=None, tags=None, connection_auth=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a resource group exists. @@ -212,7 +212,7 @@ def resource_group_present(name, location, managed_by=None, tags=None, connectio def resource_group_absent(name, connection_auth=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a resource group does not exist in the current subscription. @@ -280,7 +280,7 @@ def policy_definition_present(name, policy_rule=None, policy_type=None, mode=Non template='jinja', source_hash=None, source_hash_name=None, skip_verify=False, connection_auth=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a security policy definition exists. @@ -546,7 +546,7 @@ def policy_definition_present(name, policy_rule=None, policy_type=None, mode=Non def policy_definition_absent(name, connection_auth=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a policy definition does not exist in the current subscription. @@ -602,7 +602,7 @@ def policy_definition_absent(name, connection_auth=None): def policy_assignment_present(name, scope, definition_name, display_name=None, description=None, assignment_type=None, parameters=None, connection_auth=None, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a security policy assignment exists. @@ -755,7 +755,7 @@ def policy_assignment_present(name, scope, definition_name, display_name=None, d def policy_assignment_absent(name, scope, connection_auth=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Ensure a policy assignment does not exist in the provided scope. diff --git a/salt/states/cimc.py b/salt/states/cimc.py index 61afafaf59c..3ee314f8537 100644 --- a/salt/states/cimc.py +++ b/salt/states/cimc.py @@ -47,7 +47,7 @@ def hostname(name, hostname=None): ''' Ensures that the hostname is set to the specified value. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 name: The name of the module function to execute. @@ -106,7 +106,7 @@ def logging_levels(name, remote=None, local=None): must match the following options: emergency, alert, critical, error, warning, notice, informational, debug. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 name: The name of the module function to execute. @@ -252,7 +252,7 @@ def 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. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 name: The name of the module function to execute. @@ -439,7 +439,7 @@ def user(name, id='', user='', priv='', password='', status='active'): Ensures that a user is configured on the device. Due to being unable to verify the user password. This is a forced operation. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 name: The name of the module function to execute. diff --git a/salt/states/cmd.py b/salt/states/cmd.py index 069274105c9..4d20b513817 100644 --- a/salt/states/cmd.py +++ b/salt/states/cmd.py @@ -521,7 +521,7 @@ def wait(name, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 ''' # Ignoring our arguments is intentional. return {'name': name, @@ -660,7 +660,7 @@ def wait_script(name, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 ''' # Ignoring our arguments is intentional. return {'name': name, @@ -821,7 +821,7 @@ def run(name, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. note:: @@ -1094,7 +1094,7 @@ def script(name, return code returned from the run matches any in the provided list, the return code will be overridden with zero. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 ''' test_name = None diff --git a/salt/states/docker_container.py b/salt/states/docker_container.py index 4e389d87181..71798bbec59 100644 --- a/salt/states/docker_container.py +++ b/salt/states/docker_container.py @@ -384,7 +384,7 @@ def running(name, **NETWORK MANAGEMENT** .. versionadded:: 2018.3.0 - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 If the ``networks`` option is used, any networks (including the default ``bridge`` network) which are not specified will be disconnected. @@ -424,7 +424,7 @@ def running(name, .. _`connect_container_to_network`: https://docker-py.readthedocs.io/en/stable/api.html#docker.api.network.NetworkApiMixin.connect_container_to_network To start a container with no network connectivity (only possible in - Fluorine and later) pass this option as an empty list. For example: + 2019.2.0 and later) pass this option as an empty list. For example: .. code-block:: yaml diff --git a/salt/states/file.py b/salt/states/file.py index 7bc71a2cb17..dfbe672daa7 100644 --- a/salt/states/file.py +++ b/salt/states/file.py @@ -5630,7 +5630,7 @@ def patch(name, ''' Ensure that a patch has been applied to the specified file or directory - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The ``hash`` and ``dry_run_first`` 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 @@ -5653,7 +5653,7 @@ def patch(name, source The patch file to apply - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 The source can now be from any file source supported by Salt (``salt://``, ``http://``, ``https://``, ``ftp://``, etc.). Templating is also now supported. @@ -5662,37 +5662,37 @@ def patch(name, Works the same way as in :py:func:`file.managed `. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 source_hash_name Works the same way as in :py:func:`file.managed ` - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 skip_verify Works the same way as in :py:func:`file.managed ` - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 template Works the same way as in :py:func:`file.managed ` - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 context Works the same way as in :py:func:`file.managed ` - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 defaults Works the same way as in :py:func:`file.managed ` - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 options Extra options to pass to patch. This should not be necessary in most @@ -5714,7 +5714,7 @@ def patch(name, The parent directory must exist. Also, this will overwrite the file if it is already present. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 strip Number of directories to strip from paths in the patch file. For @@ -5728,7 +5728,7 @@ def patch(name, - source: salt://myfile.patch - strip: 1 - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 In previous versions, ``-p1`` would need to be passed as part of the ``options`` value. @@ -6673,7 +6673,7 @@ def serialize(name, deserializing JSON, arguments like ``parse_float`` and ``parse_int`` which accept a callable object cannot be handled in an SLS file. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 For example, this state: diff --git a/salt/states/git.py b/salt/states/git.py index 1daea423bc2..5a43bbdb094 100644 --- a/salt/states/git.py +++ b/salt/states/git.py @@ -445,7 +445,7 @@ def latest(name, argument to ``True`` to force a hard-reset to the remote revision in these cases. - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 This option can now be set to ``remote-changes``, which will instruct Salt not to discard local changes if the repo is up-to-date with the remote repository. @@ -489,7 +489,7 @@ def latest(name, with a long history. Use rev to specify branch or tag. This is not compatible with revision IDs. - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 This option now supports tags as well as branches, on Git 1.8.0 and newer. @@ -2753,7 +2753,7 @@ def cloned(name, https_pass=None, output_encoding=None): ''' - .. versionadded:: 2018.3.3,Fluorine + .. versionadded:: 2018.3.3,2019.2.0 Ensure that a repository has been cloned to the specified target directory. If not, clone that repository. No fetches will be performed once cloned. diff --git a/salt/states/glusterfs.py b/salt/states/glusterfs.py index 32556d9efdd..5df947dc27f 100644 --- a/salt/states/glusterfs.py +++ b/salt/states/glusterfs.py @@ -125,7 +125,7 @@ def volume_present(name, bricks, stripe=False, replica=False, device_vg=False, arbiter use every third brick as arbiter (metadata only) - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 start ensure that the volume is also started @@ -325,7 +325,7 @@ def add_volume_bricks(name, bricks): def op_version(name, version): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Add brick(s) to an existing volume @@ -377,7 +377,7 @@ def op_version(name, version): def max_op_version(name): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Add brick(s) to an existing volume diff --git a/salt/states/kapacitor.py b/salt/states/kapacitor.py index da182470f45..cbaf6cdbda1 100644 --- a/salt/states/kapacitor.py +++ b/salt/states/kapacitor.py @@ -53,7 +53,7 @@ def task_present(name, to fetch data from. For backward compatibility, the value of 'database' and 'retention_policy' will be merged as part of dbrps. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 database Which database to fetch data from. Defaults to None, which will use the diff --git a/salt/states/kubernetes.py b/salt/states/kubernetes.py index 3d12fbfc91c..1a8d0181095 100644 --- a/salt/states/kubernetes.py +++ b/salt/states/kubernetes.py @@ -8,7 +8,7 @@ salt.modules.kubernetes for more information. .. warning:: - Configuration options will change in Fluorine. + Configuration options will change in 2019.2.0. The kubernetes module is used to manage different kubernetes resources. diff --git a/salt/states/lxd.py b/salt/states/lxd.py index 681deb42dd0..cd965ae9a65 100644 --- a/salt/states/lxd.py +++ b/salt/states/lxd.py @@ -2,7 +2,7 @@ ''' Manage LXD profiles. -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 .. note: diff --git a/salt/states/lxd_container.py b/salt/states/lxd_container.py index c92fc5aa72e..ea1a5f6425e 100644 --- a/salt/states/lxd_container.py +++ b/salt/states/lxd_container.py @@ -2,7 +2,7 @@ ''' Manage LXD containers. -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 .. note: diff --git a/salt/states/lxd_image.py b/salt/states/lxd_image.py index 0e2876a151f..bc3ebf719f9 100644 --- a/salt/states/lxd_image.py +++ b/salt/states/lxd_image.py @@ -2,7 +2,7 @@ ''' Manage LXD images. -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 .. note: diff --git a/salt/states/lxd_profile.py b/salt/states/lxd_profile.py index 36a6adad52e..33b371a38f1 100644 --- a/salt/states/lxd_profile.py +++ b/salt/states/lxd_profile.py @@ -2,7 +2,7 @@ ''' Manage LXD profiles. -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 .. note: diff --git a/salt/states/netconfig.py b/salt/states/netconfig.py index 5b94f04343a..b1f8ed65e4d 100644 --- a/salt/states/netconfig.py +++ b/salt/states/netconfig.py @@ -118,7 +118,7 @@ def replace_pattern(name, debug=False, commit=True): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Replace occurrences of a pattern in the configuration source. If ``show_changes`` is ``True``, then a diff of what changed will be returned, @@ -270,7 +270,7 @@ def saved(name, win_perms_reset=False, **kwargs): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Save the configuration to a file on the local file system. @@ -511,7 +511,7 @@ def managed(name, - ``https:/example.com/template.mako`` - ``ftp://example.com/template.py`` - .. versionchanged:: Fluorine + .. versionchanged:: 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. @@ -585,7 +585,7 @@ def managed(name, applies a manual configuration change, or a different process or command changes the configuration in the meanwhile). - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 commit_at: ``None`` Commit the changes at a specific time. Example of accepted formats: @@ -609,7 +609,7 @@ def managed(name, applies a manual configuration change, or a different process or command changes the configuration in the meanwhile). - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 revert_in: ``None`` Commit and revert the changes in a specific number of minutes / hours. @@ -640,7 +640,7 @@ def managed(name, commit and till the changes are reverted), these changes would be equally reverted, as Salt cannot be aware of them. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 revert_at: ``None`` Commit and revert the changes at a specific time. Example of accepted @@ -670,7 +670,7 @@ def managed(name, commit and till the changes are reverted), these changes would be equally reverted, as Salt cannot be aware of them. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 replace: False Load and replace the configuration. Default: ``False`` (will apply load merge). @@ -678,7 +678,7 @@ def managed(name, context: None Overrides default context variables passed to the template. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 defaults: None Default variables/context passed to the template. @@ -850,7 +850,7 @@ def managed(name, def commit_cancelled(name): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Cancel a commit scheduled to be executed via the ``commit_in`` and ``commit_at`` arguments from the @@ -882,7 +882,7 @@ def commit_cancelled(name): def commit_confirmed(name): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Confirm a commit scheduled to be reverted via the ``revert_in`` and ``revert_at`` arguments from the diff --git a/salt/states/postgres_initdb.py b/salt/states/postgres_initdb.py index 9ad83242d90..d91aec8a506 100644 --- a/salt/states/postgres_initdb.py +++ b/salt/states/postgres_initdb.py @@ -67,14 +67,14 @@ def present(name, The transaction log (WAL) directory (default is to keep WAL inside the data directory) - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 checksums If True, the cluster will be created with data page checksums. .. note:: Data page checksums are supported since PostgreSQL 9.3. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 runas The system user the operation should be performed on behalf of diff --git a/salt/states/reg.py b/salt/states/reg.py index d41c8938b5c..f776a342301 100644 --- a/salt/states/reg.py +++ b/salt/states/reg.py @@ -199,7 +199,7 @@ def present(name, Owner is set for the key that contains the value/data pair. You cannot set ownership on value/data pairs themselves. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 win_perms (dict): A dictionary containing permissions to grant and their propagation. @@ -244,7 +244,7 @@ def present(name, - this_key_subkeys - subkeys_only - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 win_deny_perms (dict): A dictionary containing permissions to deny and their propagation. @@ -260,7 +260,7 @@ def present(name, 'Deny' permissions always take precedence over 'grant' permissions. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 win_inheritance (bool): ``True`` to inherit permissions from the parent key. ``False`` to @@ -270,7 +270,7 @@ def present(name, Inheritance is set for the key that contains the value/data pair. You cannot set inheritance on value/data pairs themselves. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 win_perms_reset (bool): If ``True`` the existing DACL will be cleared and replaced with the @@ -281,7 +281,7 @@ def present(name, Perms are reset for the key that contains the value/data pair. You cannot set permissions on value/data pairs themselves. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Returns: dict: A dictionary showing the results of the registry operation. diff --git a/salt/states/selinux.py b/salt/states/selinux.py index 91ed5c108cb..2078352d02a 100644 --- a/salt/states/selinux.py +++ b/salt/states/selinux.py @@ -483,7 +483,7 @@ def fcontext_policy_applied(name, recursive=False): def port_policy_present(name, sel_type, protocol=None, port=None, sel_range=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Makes sure an SELinux port policy for a given port, protocol and SELinux context type is present. @@ -538,7 +538,7 @@ def port_policy_present(name, sel_type, protocol=None, port=None, sel_range=None def port_policy_absent(name, sel_type=None, protocol=None, port=None): ''' - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Makes sure an SELinux port policy for a given port, protocol and SELinux context type is absent. diff --git a/salt/states/smartos.py b/salt/states/smartos.py index 2dba794ac02..f28317e5567 100644 --- a/salt/states/smartos.py +++ b/salt/states/smartos.py @@ -727,7 +727,7 @@ def vm_present(name, vmconfig, config=None): e.g. disk0 will be the first disk added, disk1 the 2nd,... - .. versionchanged:: Fluorine + .. versionchanged:: 2019.2.0 Added support for docker image uuids, added auto_lx_vars configuration, documented some missing configuration options. diff --git a/salt/states/svn.py b/salt/states/svn.py index bbedc91673b..604bfcd4ea7 100644 --- a/salt/states/svn.py +++ b/salt/states/svn.py @@ -92,7 +92,7 @@ def latest(name, specified string is passed to SVN's --trust-server-cert-failures option as-is. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 ''' ret = {'name': name, 'result': True, 'comment': '', 'changes': {}} if not target: @@ -242,7 +242,7 @@ def export(name, specified string is passed to SVN's --trust-server-cert-failures option as-is. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 ''' ret = {'name': name, 'result': True, 'comment': '', 'changes': {}} if not target: diff --git a/salt/states/virt.py b/salt/states/virt.py index fe155f93d72..90693880df2 100644 --- a/salt/states/virt.py +++ b/salt/states/virt.py @@ -192,13 +192,13 @@ def stopped(name, connection=None, username=None, password=None): :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. code-block:: yaml @@ -218,13 +218,13 @@ def powered_off(name, connection=None, username=None, password=None): :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. code-block:: yaml @@ -266,68 +266,68 @@ def running(name, :param mem: amount of memory in MiB for the new virtual machine :param image: disk image to use for the first disk of the new VM - .. deprecated:: Fluorine + .. deprecated:: 2019.2.0 :param vm_type: 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 ``'qemu'`` type instead of the ``'kvm'`` one. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param disk_profile: Name of the disk profile to use for the new virtual machine - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param disks: List of disk to create for the new virtual machine. See :ref:`init-disk-def` for more details on the items on this list. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param nic_profile: Name of the network interfaces profile to use for the new virtual machine - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param interfaces: List of network interfaces to create for the new virtual machine. See :ref:`init-nic-def` for more details on the items on this list. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param graphics: Graphics device to create for the new virtual machine. See :ref:`init-graphics-def` for more details on this dictionary - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param saltenv: Fileserver environment (Default: ``'base'``). See :mod:`cp module for more details ` - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param seed: ``True`` to seed the disk image. Only used when the ``image`` parameter is provided. (Default: ``True``) - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param install: install salt minion if absent (Default: ``True``) - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param pub_key: public key to seed with (Default: ``None``) - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param priv_key: public key to seed with (Default: ``None``) - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param seed_cmd: Salt command to execute to seed the image. (Default: ``'seed.apply'``) - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param update: set to ``True`` to update a defined module. (Default: ``False``) - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param os_type: type of virtualization as found in the ``//os/type`` element of the libvirt definition. The default value is taken from the host capabilities, with a preference for ``hvm``. @@ -476,13 +476,13 @@ def snapshot(name, suffix=None, connection=None, username=None, password=None): :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. code-block:: yaml @@ -510,13 +510,13 @@ def rebooted(name, connection=None, username=None, password=None): :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 ''' return _virt_call(name, 'reboot', 'rebooted', "Machine has been rebooted", @@ -637,13 +637,13 @@ def network_running(name, :param connection: libvirt connection URI, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param username: username to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param password: password to connect with, overriding defaults - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 .. code-block:: yaml @@ -709,7 +709,7 @@ def pool_running(name, ''' Defines and starts a new pool with specified arguments. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 :param ptype: libvirt pool type :param target: full path to the target device or folder. (Default: ``None``) diff --git a/salt/utils/azurearm.py b/salt/utils/azurearm.py index 60aa03c80fb..8bae9761598 100644 --- a/salt/utils/azurearm.py +++ b/salt/utils/azurearm.py @@ -2,7 +2,7 @@ ''' Azure (ARM) Utilities -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 :maintainer: :maturity: new diff --git a/salt/utils/locales.py b/salt/utils/locales.py index 16092b889c1..aa42b90e352 100644 --- a/salt/utils/locales.py +++ b/salt/utils/locales.py @@ -38,7 +38,7 @@ def sdecode(string_): 'Sodium', 'Use of \'salt.utils.locales.sdecode\' detected. This function ' 'has been replaced by \'salt.utils.data.decode\' as of ' - 'Salt Fluorine. This warning will be removed in Salt Sodium.', + 'Salt 2019.2.0. This warning will be removed in Salt Sodium.', stacklevel=3 ) return salt.utils.data.decode(string_) @@ -49,7 +49,7 @@ def sdecode_if_string(value_): 'Sodium', 'Use of \'salt.utils.locales.sdecode_if_string\' detected. This ' 'function has been replaced by \'salt.utils.data.decode\' as of ' - 'Salt Fluorine. This warning will be removed in Salt Sodium.', + 'Salt 2019.2.0. This warning will be removed in Salt Sodium.', stacklevel=3 ) return salt.utils.data.decode(value_) diff --git a/salt/utils/win_dacl.py b/salt/utils/win_dacl.py index a61d2a23b86..8eb69c024a4 100644 --- a/salt/utils/win_dacl.py +++ b/salt/utils/win_dacl.py @@ -2212,7 +2212,7 @@ def check_perms(obj_name, Check owner and permissions for the passed directory. This function checks the permissions and sets them, returning the changes made. - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Args: @@ -2476,7 +2476,7 @@ def set_perms(obj_name, ''' Set permissions for the given path - .. versionadded:: Fluorine + .. versionadded:: 2019.2.0 Args: diff --git a/salt/utils/win_lgpo_netsh.py b/salt/utils/win_lgpo_netsh.py index a31cc7f33f8..f284651ff4b 100644 --- a/salt/utils/win_lgpo_netsh.py +++ b/salt/utils/win_lgpo_netsh.py @@ -3,7 +3,7 @@ r''' A salt util for modifying firewall settings. .. versionadded:: 2018.3.4 -.. versionadded:: Fluorine +.. versionadded:: 2019.2.0 This util allows you to modify firewall settings in the local group policy in addition to the normal firewall settings. Parameters are taken from the diff --git a/salt/version.py b/salt/version.py index 505886ea684..50169ed6795 100644 --- a/salt/version.py +++ b/salt/version.py @@ -98,7 +98,7 @@ class SaltStackVersion(object): 'Carbon' : (2016, 11), 'Nitrogen' : (2017, 7), 'Oxygen' : (2018, 3), - 'Fluorine' : (MAX_SIZE - 100, 0), + '2019.2.0' : (MAX_SIZE - 100, 0), 'Neon' : (MAX_SIZE - 99, 0), 'Sodium' : (MAX_SIZE - 98, 0), 'Magnesium' : (MAX_SIZE - 97, 0),