From 66cf74140b0c30add27371c034834315c6faca30 Mon Sep 17 00:00:00 2001 From: Megan Wilhite Date: Tue, 27 Apr 2021 11:47:47 -0400 Subject: [PATCH] Merge Freeze into Master (#60074) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Merge 3002.6 bugfix changes (#59822) * Pass `CI_RUN` as an environment variable to the test run. This allows us to know if we're running the test suite under a CI environment or not and adapt/adjust if needed * Migrate `unit.setup` to PyTest * Backport ae36b15 just for test_install.py * Only skip tests on CI runs * Always store git sha in _version.py during installation * Fix PEP440 compliance. The wheel metadata version 1.2 states that the package version MUST be PEP440 compliant. This means that instead of `3002.2-511-g033c53eccb`, the salt version string should look like `3002.2+511.g033c53eccb`, a post release of `3002.2` ahead by 511 commits with the git sha `033c53eccb` * Fix and migrate `tests/unit/test_version.py` to PyTest * Skip test if `easy_install` is not available * We also need to be PEP440 compliant when there's no git history * Allow extra_filerefs as sanitized kwargs for SSH client * Fix regression on cmd.run when passing tuples as cmd Co-authored-by: Alexander Graul * Add unit tests to ensure cmd.run accepts tuples * Add unit test to check for extra_filerefs on SSH opts * Add changelog file * Fix comment for test case * Fix unit test to avoid failing on Windows * Skip failing test on windows * Fix test to work on Windows * Add all ssh kwargs to sanitize_kwargs method * Run pre-commit * Fix pylint * Fix cmdmod loglevel and module_names tests * Fix pre-commit * Skip ssh tests if binary does not exist * Use setup_loader for cmdmod test * Prevent argument injection in restartcheck * Add changelog for restartcheck fix * docs_3002.6 * Add back tests removed in merge Co-authored-by: Pedro Algarvio Co-authored-by: Megan Wilhite Co-authored-by: Bryce Larson Co-authored-by: Pablo Suárez Hernández Co-authored-by: Alexander Graul Co-authored-by: Frode Gundersen * Remove glance state module in favor of glance_image * update wording in changelog * bump deprecation warning to Silicon. * Updating warnutil version to Phosphorous. * Update salt/modules/keystone.py Co-authored-by: Megan Wilhite * Check $HOMEBREW_PREFIX when linking against libcrypto When loading `libcrypto`, Salt checks for a Homebrew installation of `openssl` at Homebrew's default prefix of `/usr/local`. However, on Apple Silicon Macs, Homebrew's default installation prefix is `/opt/homebrew`. On all platforms, the prefix is configurable. If Salt doesn't find one of those `libcrypto`s, it will fall back on the un-versioned `/usr/lib/libcrypto.dylib`, which will cause the following crash: Application Specific Information: /usr/lib/libcrypto.dylib abort() called Invalid dylib load. Clients should not load the unversioned libcrypto dylib as it does not have a stable ABI. This commit checks $HOMEBREW_PREFIX instead of hard-coding `/usr/local`. * Add test case * Add changelog for 59808 * Add changelog entry * Make _find_libcrypto fail on Big Sur if it can't find a library Right now, if `_find_libcrypto` can't find any externally-managed versions of libcrypto, it will fall back on the pre-Catalina un-versioned system libcrypto. This does not exist on Big Sur and it would be better to raise an exception here rather than crashing later when trying to open it. * Update _find_libcrypto tests This commit simplifies the unit tests for _find_libcrypto by mocking out the host's filesystem and testing the common libcrypto installations (brew, ports, etc.) on Big Sur. It simplifies the tests for falling back on system versions of libcrypto on previous versions of macOS. * Fix description of test_find_libcrypto_with_system_before_catalina * Patch sys.platform for test_rsax931 tests * modules/match: add missing "minion_id" in Pillar example The documented Pillar example for `match.filter_by` lacks the `minion_id` parameter. Without it, the assignment won't work as expected. - fix documentation - add tests: - to prove the misbehavior of the documented example - to prove the proper behaviour when supplying `minion_id` - to ensure some misbehaviour observed with compound matchers doesn't occur * Fix for issue #59773 - When instantiating the loader grab values of grains and pillars if they are NamedLoaderContext instances. - The loader uses a copy of opts. - Impliment deepcopy on NamedLoaderContext instances. * Add changelog for #59773 * _get_initial_pillar function returns pillar * Fix linter issues * Clean up test * Bump deprecation release for neutron * Uncomment Sulfur release name * Removing the _ext_nodes deprecation warning and alias. * Adding changelog. * Renaming changelog file. * Update 59804.removed * Initial pass at fips_mode config option * Fix pre-commit * Fix tests and add changelog * update docs 3003 * update docs 3003 - newline * Fix warts in changelog * update releasenotes 3003 * add ubuntu-2004-amd64 m2crypto pycryptodome and tcp tests * add distro_arch * changing the cloud platforms file missed in 1a9b7be0e2f300d87924731dc5816fd1000cd22b * Update __utils__ calls to import utils in azure * Add changelog for 59744 * Fix azure unit tests and move to pytest * Use contextvars from site-packages for thin If a contextvars package exists one of the site-packages locations use it for the generated thin tarball. This overrides python's builtin contextvars and allows salt-ssh to work with python <=3.6 even when the master's python is >3.6 (Fixes #59942) * Add regression test for #59942 * Add changelog for #59942 * Update filemap to include test_py_versions * Fix broken thin tests * Always install the `contextvars` backport, even on Py3.7+ Without this change, salt-ssh cannot target systems with Python <= 3.6 * Use salt-factories to handle the container. Don't override default roster * Fix thin tests on windows * No need to use warn log level here * Fix getsitepackages for old virtualenv versions * Add explicit pyobjc reqs * Add back the passthrough stuff * Remove a line so pre-commit will run * Bugfix release docs * Bugfix release docs * Removing pip-compile log files * Fix failing test tests.unit.grains.test_core.CoreGrainsTestCase.test_xen_virtual * Fix pre-commit for docs.txt reqs Co-authored-by: Daniel Wozniak Co-authored-by: Pedro Algarvio Co-authored-by: Bryce Larson Co-authored-by: Pablo Suárez Hernández Co-authored-by: Alexander Graul Co-authored-by: Frode Gundersen Co-authored-by: Gareth J. Greenaway Co-authored-by: Gareth J. Greenaway Co-authored-by: Hoa-Long Tam Co-authored-by: krionbsd Co-authored-by: Elias Probst Co-authored-by: Daniel A. Wozniak Co-authored-by: Frode Gundersen Co-authored-by: twangboy Co-authored-by: twangboy Co-authored-by: ScriptAutomate --- .pre-commit-config.yaml | 15 +- CHANGELOG.md | 16 + doc/man/salt-api.1 | 2 +- doc/man/salt-call.1 | 2 +- doc/man/salt-cloud.1 | 2 +- doc/man/salt-cp.1 | 2 +- doc/man/salt-key.1 | 2 +- doc/man/salt-master.1 | 2 +- doc/man/salt-minion.1 | 2 +- doc/man/salt-proxy.1 | 2 +- doc/man/salt-run.1 | 2 +- doc/man/salt-ssh.1 | 2 +- doc/man/salt-syndic.1 | 2 +- doc/man/salt-unity.1 | 2 +- doc/man/salt.1 | 2 +- doc/man/salt.7 | 4480 ++++++++++++----- doc/man/spm.1 | 2 +- doc/topics/releases/3003.1.rst | 19 + requirements/base.txt | 2 +- requirements/darwin.txt | 2 +- requirements/pyobjc.txt | 123 + requirements/static/ci/py3.5/darwin.txt | 121 +- requirements/static/ci/py3.5/docs.txt | 2 +- requirements/static/ci/py3.5/freebsd.txt | 2 +- requirements/static/ci/py3.5/linux.log | 0 requirements/static/ci/py3.5/linux.txt | 2 +- requirements/static/ci/py3.6/darwin.txt | 121 +- requirements/static/ci/py3.6/docs.txt | 2 +- requirements/static/ci/py3.6/freebsd.txt | 2 +- requirements/static/ci/py3.6/linux.log | 0 requirements/static/ci/py3.6/linux.txt | 2 +- requirements/static/ci/py3.6/windows.txt | 2 +- requirements/static/ci/py3.7/darwin.txt | 121 + requirements/static/ci/py3.7/docs.txt | 2 + requirements/static/ci/py3.7/freebsd.txt | 2 + requirements/static/ci/py3.7/linux.txt | 2 + requirements/static/ci/py3.7/windows.txt | 2 + requirements/static/ci/py3.8/darwin.txt | 121 + requirements/static/ci/py3.8/docs.txt | 2 + requirements/static/ci/py3.8/freebsd.txt | 2 + requirements/static/ci/py3.8/linux.txt | 2 + requirements/static/ci/py3.9/darwin.txt | 121 + requirements/static/ci/py3.9/docs.txt | 2 + requirements/static/ci/py3.9/freebsd.txt | 2 + requirements/static/ci/py3.9/linux.txt | 2 + requirements/static/pkg/py3.5/darwin.txt | 125 +- requirements/static/pkg/py3.5/freebsd.txt | 2 +- requirements/static/pkg/py3.5/linux.txt | 2 +- requirements/static/pkg/py3.6/darwin.txt | 125 +- requirements/static/pkg/py3.6/freebsd.txt | 2 +- requirements/static/pkg/py3.6/linux.txt | 2 +- requirements/static/pkg/py3.6/windows.txt | 2 +- requirements/static/pkg/py3.7/darwin.txt | 125 +- requirements/static/pkg/py3.7/freebsd.txt | 2 + requirements/static/pkg/py3.7/linux.txt | 2 + requirements/static/pkg/py3.7/windows.txt | 2 + requirements/static/pkg/py3.8/darwin.txt | 125 +- requirements/static/pkg/py3.8/freebsd.txt | 2 + requirements/static/pkg/py3.8/linux.txt | 2 + requirements/static/pkg/py3.9/darwin.txt | 125 +- requirements/static/pkg/py3.9/freebsd.txt | 2 + requirements/static/pkg/py3.9/linux.txt | 2 + requirements/tests.txt | 0 salt/loader.py | 8 +- salt/loader_context.py | 8 +- salt/utils/thin.py | 80 +- tests/filename_map.yml | 1 + tests/pytests/conftest.py | 8 +- .../integration/ssh/test_py_versions.py | 153 + tests/unit/grains/test_core.py | 4 +- tests/unit/utils/test_thin.py | 160 +- 71 files changed, 4881 insertions(+), 1514 deletions(-) create mode 100644 doc/topics/releases/3003.1.rst create mode 100644 requirements/pyobjc.txt delete mode 100644 requirements/static/ci/py3.5/linux.log delete mode 100644 requirements/static/ci/py3.6/linux.log delete mode 100644 requirements/tests.txt create mode 100644 tests/pytests/integration/ssh/test_py_versions.py diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c09445a2619..9d711a673ee 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -142,65 +142,70 @@ repos: - id: pip-tools-compile alias: compile-pkg-darwin-3.5-zmq-requirements name: Darwin Packaging Py3.5 ZeroMQ Requirements - files: ^(requirements/((base|zeromq|crypto|darwin)\.txt|static/pkg/(darwin\.in|py3\.5/darwin\.txt)))$ + files: ^(requirements/((base|zeromq|crypto|darwin|pyobjc)\.txt|static/pkg/(darwin\.in|py3\.5/darwin\.txt)))$ pass_filenames: false args: - -v - --py-version=3.5 - --platform=darwin - --include=requirements/darwin.txt + - --include=requirements/pyobjc.txt - --passthrough-line-from-input=^pyobjc(.*)$ - requirements/static/pkg/darwin.in - id: pip-tools-compile alias: compile-pkg-darwin-3.6-zmq-requirements name: Darwin Packaging Py3.6 ZeroMQ Requirements - files: ^(requirements/((base|zeromq|crypto|darwin)\.txt|static/pkg/(darwin\.in|py3\.6/darwin\.txt)))$ + files: ^(requirements/((base|zeromq|crypto|darwin|pyobjc)\.txt|static/pkg/(darwin\.in|py3\.6/darwin\.txt)))$ pass_filenames: false args: - -v - --py-version=3.6 - --platform=darwin - --include=requirements/darwin.txt + - --include=requirements/pyobjc.txt - --passthrough-line-from-input=^pyobjc(.*)$ - requirements/static/pkg/darwin.in - id: pip-tools-compile alias: compile-pkg-darwin-3.7-zmq-requirements name: Darwin Packaging Py3.7 ZeroMQ Requirements - files: ^(requirements/((base|zeromq|crypto|darwin)\.txt|static/pkg/(darwin\.in|py3\.7/darwin\.txt)))$ + files: ^(requirements/((base|zeromq|crypto|darwin|pyobjc)\.txt|static/pkg/(darwin\.in|py3\.7/darwin\.txt)))$ pass_filenames: false args: - -v - --py-version=3.7 - --platform=darwin - --include=requirements/darwin.txt + - --include=requirements/pyobjc.txt - --passthrough-line-from-input=^pyobjc(.*)$ - requirements/static/pkg/darwin.in - id: pip-tools-compile alias: compile-pkg-darwin-3.8-zmq-requirements name: Darwin Packaging Py3.8 ZeroMQ Requirements - files: ^(requirements/((base|zeromq|crypto|darwin)\.txt|static/pkg/(darwin\.in|py3\.8/darwin\.txt)))$ + files: ^(requirements/((base|zeromq|crypto|darwin|pyobjc)\.txt|static/pkg/(darwin\.in|py3\.8/darwin\.txt)))$ pass_filenames: false args: - -v - --py-version=3.8 - --platform=darwin - --include=requirements/darwin.txt + - --include=requirements/pyobjc.txt - --passthrough-line-from-input=^pyobjc(.*)$ - requirements/static/pkg/darwin.in - id: pip-tools-compile alias: compile-pkg-darwin-3.9-zmq-requirements name: Darwin Packaging Py3.9 ZeroMQ Requirements - files: ^(requirements/((base|zeromq|crypto|darwin)\.txt|static/pkg/(darwin\.in|py3\.9/darwin\.txt)))$ + files: ^(requirements/((base|zeromq|crypto|darwin|pyobjc)\.txt|static/pkg/(darwin\.in|py3\.9/darwin\.txt)))$ pass_filenames: false args: - -v - --py-version=3.9 - --platform=darwin - --include=requirements/darwin.txt + - --include=requirements/pyobjc.txt - --passthrough-line-from-input=^pyobjc(.*)$ - requirements/static/pkg/darwin.in diff --git a/CHANGELOG.md b/CHANGELOG.md index deab909de78..42e8f505c53 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,22 @@ Versions are `MAJOR.PATCH`. # Changelog +Salt 3003.1 (2021-04-20) +======================== + +Removed +------- + +- Removed support for Ubuntu 16.04 (#59913) + + +Fixed +----- + +- Import salt.utils.azurearm instead of using __utils__ from loader in azure cloud. This fixes an issue where __utils__ would become unavailable when we are using the ThreadPool in azurearm. (#59744) +- Use contextvars libary from site-packages if it is intalled. Fixes salt ssh for targets with python <=3.6 (#59942) + + Salt 3003 (2021-03-05) ====================== diff --git a/doc/man/salt-api.1 b/doc/man/salt-api.1 index 4ddc821c596..d83fc1e66c4 100644 --- a/doc/man/salt-api.1 +++ b/doc/man/salt-api.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-API" "1" "Feb 23, 2021" "3003" "Salt" +.TH "SALT-API" "1" "Apr 20, 2021" "3003.1" "Salt" .SH NAME salt-api \- salt-api Command . diff --git a/doc/man/salt-call.1 b/doc/man/salt-call.1 index dcbe51d4672..2a4d903c0ab 100644 --- a/doc/man/salt-call.1 +++ b/doc/man/salt-call.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-CALL" "1" "Feb 23, 2021" "3003" "Salt" +.TH "SALT-CALL" "1" "Apr 20, 2021" "3003.1" "Salt" .SH NAME salt-call \- salt-call Documentation . diff --git a/doc/man/salt-cloud.1 b/doc/man/salt-cloud.1 index 362b5daefc4..60232417c13 100644 --- a/doc/man/salt-cloud.1 +++ b/doc/man/salt-cloud.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-CLOUD" "1" "Feb 23, 2021" "3003" "Salt" +.TH "SALT-CLOUD" "1" "Apr 20, 2021" "3003.1" "Salt" .SH NAME salt-cloud \- Salt Cloud Command . diff --git a/doc/man/salt-cp.1 b/doc/man/salt-cp.1 index 4054fe84b7e..6ca6c9c2e83 100644 --- a/doc/man/salt-cp.1 +++ b/doc/man/salt-cp.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-CP" "1" "Feb 23, 2021" "3003" "Salt" +.TH "SALT-CP" "1" "Apr 20, 2021" "3003.1" "Salt" .SH NAME salt-cp \- salt-cp Documentation . diff --git a/doc/man/salt-key.1 b/doc/man/salt-key.1 index 9c9dd7c5b31..cf36e80c3b7 100644 --- a/doc/man/salt-key.1 +++ b/doc/man/salt-key.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-KEY" "1" "Feb 23, 2021" "3003" "Salt" +.TH "SALT-KEY" "1" "Apr 20, 2021" "3003.1" "Salt" .SH NAME salt-key \- salt-key Documentation . diff --git a/doc/man/salt-master.1 b/doc/man/salt-master.1 index b2b3c3fa66e..4a7f6936a86 100644 --- a/doc/man/salt-master.1 +++ b/doc/man/salt-master.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-MASTER" "1" "Feb 23, 2021" "3003" "Salt" +.TH "SALT-MASTER" "1" "Apr 20, 2021" "3003.1" "Salt" .SH NAME salt-master \- salt-master Documentation . diff --git a/doc/man/salt-minion.1 b/doc/man/salt-minion.1 index 09a1f75f6b8..29e24f75177 100644 --- a/doc/man/salt-minion.1 +++ b/doc/man/salt-minion.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-MINION" "1" "Feb 23, 2021" "3003" "Salt" +.TH "SALT-MINION" "1" "Apr 20, 2021" "3003.1" "Salt" .SH NAME salt-minion \- salt-minion Documentation . diff --git a/doc/man/salt-proxy.1 b/doc/man/salt-proxy.1 index 4abea4b4691..1a2ca96c0cc 100644 --- a/doc/man/salt-proxy.1 +++ b/doc/man/salt-proxy.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-PROXY" "1" "Feb 23, 2021" "3003" "Salt" +.TH "SALT-PROXY" "1" "Apr 20, 2021" "3003.1" "Salt" .SH NAME salt-proxy \- salt-proxy Documentation . diff --git a/doc/man/salt-run.1 b/doc/man/salt-run.1 index 419db160469..a45c5b40c4e 100644 --- a/doc/man/salt-run.1 +++ b/doc/man/salt-run.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-RUN" "1" "Feb 23, 2021" "3003" "Salt" +.TH "SALT-RUN" "1" "Apr 20, 2021" "3003.1" "Salt" .SH NAME salt-run \- salt-run Documentation . diff --git a/doc/man/salt-ssh.1 b/doc/man/salt-ssh.1 index 48bc9e0d7c4..1cf9a5ce47c 100644 --- a/doc/man/salt-ssh.1 +++ b/doc/man/salt-ssh.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-SSH" "1" "Feb 23, 2021" "3003" "Salt" +.TH "SALT-SSH" "1" "Apr 20, 2021" "3003.1" "Salt" .SH NAME salt-ssh \- salt-ssh Documentation . diff --git a/doc/man/salt-syndic.1 b/doc/man/salt-syndic.1 index 49a776b0e51..2ad60c6d5d8 100644 --- a/doc/man/salt-syndic.1 +++ b/doc/man/salt-syndic.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-SYNDIC" "1" "Feb 23, 2021" "3003" "Salt" +.TH "SALT-SYNDIC" "1" "Apr 20, 2021" "3003.1" "Salt" .SH NAME salt-syndic \- salt-syndic Documentation . diff --git a/doc/man/salt-unity.1 b/doc/man/salt-unity.1 index 1f26c8e5569..23ab52cc991 100644 --- a/doc/man/salt-unity.1 +++ b/doc/man/salt-unity.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT-UNITY" "1" "Feb 23, 2021" "3003" "Salt" +.TH "SALT-UNITY" "1" "Apr 20, 2021" "3003.1" "Salt" .SH NAME salt-unity \- salt-unity Command . diff --git a/doc/man/salt.1 b/doc/man/salt.1 index 1b2bc6c23e6..ed4dfc0e188 100644 --- a/doc/man/salt.1 +++ b/doc/man/salt.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT" "1" "Feb 23, 2021" "3003" "Salt" +.TH "SALT" "1" "Apr 20, 2021" "3003.1" "Salt" .SH NAME salt \- salt . diff --git a/doc/man/salt.7 b/doc/man/salt.7 index 7e2f81e1809..5c90b24c2cc 100644 --- a/doc/man/salt.7 +++ b/doc/man/salt.7 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SALT" "7" "Feb 23, 2021" "3003" "Salt" +.TH "SALT" "7" "Apr 20, 2021" "3003.1" "Salt" .SH NAME salt \- Salt Documentation . @@ -135,7 +135,9 @@ used by external modules. A complete list of attributions and dependencies can be found here: \fI\%salt/DEPENDENCIES.md\fP .SH INTRODUCTION TO SALT -We’re not just talking about NaCl..SS The 30 second summary +.sp +We’re not just talking about NaCl. +.SS The 30 second summary .sp Salt is: .INDENT 0.0 @@ -1655,15 +1657,15 @@ Example: Nexus CLI Configuration for connectivity via management interface .ft C config term vrf context management - ip name\-server 10\&.0.0.202 + ip name\-server 10.0.0.202 ip domain\-name mycompany.com - ip route 0\&.0.0.0/0 10\&.0.0.1 + ip route 0.0.0.0/0 10.0.0.1 interface mgmt0 vrf member management - ip address 10\&.0.0.99/24 + ip address 10.0.0.99/24 - ntp server 10\&.0.0.201 use\-vrf management + ntp server 10.0.0.201 use\-vrf management end .ft P .fi @@ -2367,10 +2369,10 @@ Now go to the Configuring Salt page. Salt should work properly with all mainstream derivatives of Red Hat Enterprise Linux, including CentOS, Scientific Linux, Oracle Linux, and Amazon Linux. Report any bugs or issues on the \fI\%issue tracker\fP\&. -.SS Installation from the Official SaltStack Repository +.SS Installation from the Official Salt Project Repository .sp Packages for Redhat, CentOS, and Amazon Linux are available in -the SaltStack Repository. +the Salt Project Repository. .INDENT 0.0 .IP \(bu 2 \fI\%Red Hat / CentOS\fP @@ -2402,7 +2404,7 @@ archives. Here is an example \fBsed\fP command: .nf .ft C # Salt repo configurations are found in the /etc/yum.repos.d/ directory -sed \-i \(aqs/repo.saltstack.com/archive.repo.saltstack.com/g\(aq /etc/yum.repos.d/salt*.repo +sed \-i \(aqs/repo.saltproject.io/archive.repo.saltproject.io/g\(aq /etc/yum.repos.d/salt*.repo .ft P .fi .UNINDENT @@ -2427,7 +2429,7 @@ archives. Here is an example \fBsed\fP command: .nf .ft C # Salt repo configurations are found in the /etc/yum.repos.d/ directory -sed \-i \(aqs/repo.saltstack.com/archive.repo.saltstack.com/g\(aq /etc/yum.repos.d/salt*.repo +sed \-i \(aqs/repo.saltproject.io/archive.repo.saltproject.io/g\(aq /etc/yum.repos.d/salt*.repo .ft P .fi .UNINDENT @@ -2439,7 +2441,7 @@ sed \-i \(aqs/repo.saltstack.com/archive.repo.saltstack.com/g\(aq /etc/yum.repos .INDENT 0.0 .INDENT 3.5 As of 2015.8.0, EPEL repository is no longer required for installing on -RHEL systems. SaltStack repository provides all needed dependencies. +RHEL systems. Salt Project repository provides all needed dependencies. .UNINDENT .UNINDENT .sp @@ -2448,7 +2450,7 @@ RHEL systems. SaltStack repository provides all needed dependencies. .INDENT 3.5 If installing on Red Hat Enterprise Linux 7 with disabled (not subscribed on) \(aqRHEL Server Releases\(aq or \(aqRHEL Server Optional Channel\(aq repositories, -append CentOS 7 GPG key URL to SaltStack yum repository configuration to +append CentOS 7 GPG key URL to Salt Project yum repository configuration to install required base packages: .INDENT 0.0 .INDENT 3.5 @@ -2456,12 +2458,12 @@ install required base packages: .nf .ft C [saltstack\-repo] -name=SaltStack repo for Red Hat Enterprise Linux $releasever -baseurl=https://repo.saltstack.com/yum/redhat/$releasever/$basearch/latest +name=Salt repo for Red Hat Enterprise Linux $releasever +baseurl=https://repo.saltproject.io/py3/redhat/$releasever/$basearch/latest enabled=1 gpgcheck=1 -gpgkey=https://repo.saltstack.com/yum/redhat/$releasever/$basearch/latest/SALTSTACK\-GPG\-KEY.pub - https://repo.saltstack.com/yum/redhat/$releasever/$basearch/latest/base/RPM\-GPG\-KEY\-CentOS\-7 +gpgkey=https://repo.saltproject.io/py3/redhat/$releasever/$basearch/latest/SALTSTACK\-GPG\-KEY.pub + https://repo.saltproject.io/py3/redhat/$releasever/$basearch/latest/base/RPM\-GPG\-KEY\-CentOS\-7 .ft P .fi .UNINDENT @@ -2477,87 +2479,11 @@ installed by the Red Hat 7 \fB@base\fP installation or by the Salt installation. These dependencies might need to be installed before Salt. .UNINDENT .UNINDENT -.SS Installation from the Community\-Maintained Repository -.sp -Beginning with version 0.9.4, Salt has been available in \fI\%EPEL\fP\&. -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -Packages in this repository are built by community, and it can take a little -while until the latest stable SaltStack release becomes available. Using the -SaltStack Repository is highly preferred, instead. -.UNINDENT -.UNINDENT -.SS RHEL/CentOS 6 and 7, Scientific Linux, etc. -.sp -\fBWARNING:\fP -.INDENT 0.0 -.INDENT 3.5 -Salt 2015.8 is currently not available in EPEL due to unsatisfied -dependencies: \fBpython\-crypto\fP 2.6.1 or higher, and \fBpython\-tornado\fP -version 4.2.1 or higher. These packages are not currently available in EPEL -for Red Hat Enterprise Linux 6 and 7. -.UNINDENT -.UNINDENT -.SS Enabling EPEL -.sp -If the EPEL repository is not installed on your system, you can download the -RPM for \fI\%RHEL/CentOS 6\fP or for \fI\%RHEL/CentOS 7\fP and install it -using the following command: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -rpm \-Uvh epel\-release\-X\-Y.rpm -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -Replace \fBepel\-release\-X\-Y.rpm\fP with the appropriate filename. -.SS Installing Stable Release -.sp -Salt is packaged separately for the minion and the master. It is necessary -to install only the appropriate package for the role the machine will play. -Typically, there will be one master and multiple minions. -.INDENT 0.0 -.INDENT 3.5 -.INDENT 0.0 -.IP \(bu 2 -\fByum install salt\-master\fP -.IP \(bu 2 -\fByum install salt\-minion\fP -.IP \(bu 2 -\fByum install salt\-ssh\fP -.IP \(bu 2 -\fByum install salt\-syndic\fP -.IP \(bu 2 -\fByum install salt\-cloud\fP -.UNINDENT -.UNINDENT -.UNINDENT -.SS Installing from \fBepel\-testing\fP -.sp -When a new Salt release is packaged, it is first admitted into the -\fBepel\-testing\fP repository, before being moved to the stable EPEL repository. -.sp -To install from \fBepel\-testing\fP, use the \fBenablerepo\fP argument for \fByum\fP: -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -yum \-\-enablerepo=epel\-testing install salt\-minion -.ft P -.fi -.UNINDENT -.UNINDENT .SS Installation Using pip .sp Since Salt is on \fI\%PyPI\fP, it can be installed using pip, though most users -prefer to install using RPM packages (which can be installed from \fI\%EPEL\fP). +prefer to install using RPM packages (which can be installed by following +the directions in the \fI\%Salt Repository\fP). .sp Installing from pip has a few additional requirements: .INDENT 0.0 @@ -2595,17 +2521,16 @@ More information on this can be found here\&. .UNINDENT .SS ZeroMQ 4 .sp -We recommend using ZeroMQ 4 where available. SaltStack provides ZeroMQ 4.0.5 -and \fBpyzmq\fP 14.5.0 in the \fI\%SaltStack Repository\fP\&. +We recommend using ZeroMQ 4 where available. Salt Project provides ZeroMQ 4.3.1 +and \fBpyzmq\fP 17.0.0 in the \fI\%Salt Repository\fP\&. .sp If this repository is added \fIbefore\fP Salt is installed, then installing either -\fBsalt\-master\fP or \fBsalt\-minion\fP will automatically pull in ZeroMQ 4.0.5, and +\fBsalt\-master\fP or \fBsalt\-minion\fP will automatically pull in ZeroMQ 4.3.1, and additional steps to upgrade ZeroMQ and pyzmq are unnecessary. .SS Package Management .sp Salt\(aqs interface to \fByum\fP makes heavy use of the -\fBrepoquery\fP utility, from the \fI\%yum\-utils\fP package. This package will be -installed as a dependency if salt is installed via EPEL. However, if salt has +\fBrepoquery\fP utility, from the \fI\%yum\-utils\fP package. If salt has been installed using pip, or a host is being managed using salt\-ssh, then as of version 2014.7.0 \fI\%yum\-utils\fP will be installed automatically to satisfy this dependency. @@ -2614,19 +2539,7 @@ dependency. .sp To have the Master start automatically at boot time: .sp -\fBRHEL/CentOS 5 and 6\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -chkconfig salt\-master on -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBRHEL/CentOS 7\fP +\fBRHEL/CentOS 7 and 8\fP .INDENT 0.0 .INDENT 3.5 .sp @@ -2640,19 +2553,7 @@ systemctl enable salt\-master.service .sp To start the Master: .sp -\fBRHEL/CentOS 5 and 6\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -service salt\-master start -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBRHEL/CentOS 7\fP +\fBRHEL/CentOS 7 and 8\fP .INDENT 0.0 .INDENT 3.5 .sp @@ -2667,19 +2568,7 @@ systemctl start salt\-master.service .sp To have the Minion start automatically at boot time: .sp -\fBRHEL/CentOS 5 and 6\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -chkconfig salt\-minion on -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBRHEL/CentOS 7\fP +\fBRHEL/CentOS 7 and 8\fP .INDENT 0.0 .INDENT 3.5 .sp @@ -2693,19 +2582,7 @@ systemctl enable salt\-minion.service .sp To start the Minion: .sp -\fBRHEL/CentOS 5 and 6\fP -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -service salt\-minion start -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -\fBRHEL/CentOS 7\fP +\fBRHEL/CentOS 7 and 8\fP .INDENT 0.0 .INDENT 3.5 .sp @@ -8501,6 +8378,22 @@ state_output_diff: False .fi .UNINDENT .UNINDENT +.SS \fBstate_output_profile\fP +.sp +Default: \fBTrue\fP +.sp +The \fBstate_output_profile\fP setting changes whether profile information +will be shown for each state run. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +state_output_profile: True +.ft P +.fi +.UNINDENT +.UNINDENT .SS \fBstate_aggregate\fP .sp Default: \fBFalse\fP @@ -15237,6 +15130,22 @@ state_output_diff: False .fi .UNINDENT .UNINDENT +.SS \fBstate_output_profile\fP +.sp +Default: \fBTrue\fP +.sp +The \fBstate_output_profile\fP setting changes whether profile information +will be shown for each state run. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +state_output_profile: True +.ft P +.fi +.UNINDENT +.UNINDENT .SS \fBautoload_dynamic_modules\fP .sp Default: \fBTrue\fP @@ -16396,6 +16305,12 @@ reauthenticate. The tcp transport should try to connect with a new connection if the old one times out on reauthenticating. .sp \fI\-1\fP for infinite tries. +.SS \fBtcp_reconnect_backoff\fP +.sp +Default: \fB1\fP +.sp +The time in seconds to wait before attempting another connection with salt master +when the previous connection fails while on TCP transport. .SS \fBfailhard\fP .sp Default: \fBFalse\fP @@ -17625,6 +17540,10 @@ and \fBmine_functions\fP\&. # states is cluttering the logs. Set it to True to ignore them. #state_output_diff: False +# The state_output_profile setting changes whether profile information +# will be shown for each state run. +#state_output_profile: True + # Automatically aggregate all states that have support for mod_aggregate by # setting to \(aqTrue\(aq. Or pass a list of state module names to automatically # aggregate just those types. @@ -23038,7 +22957,7 @@ the master, the syntax looks like this: .sp .nf .ft C -# salt \(aq*\(aq cp.get_file salt://vimrc /etc/vimrc +salt \(aq*\(aq cp.get_file salt://vimrc /etc/vimrc .ft P .fi .UNINDENT @@ -23054,7 +22973,7 @@ like so: .sp .nf .ft C -# salt \(aq*\(aq cp.get_file "salt://{{grains.os}}/vimrc" /etc/vimrc template=jinja +salt \(aq*\(aq cp.get_file "salt://{{grains.os}}/vimrc" /etc/vimrc template=jinja .ft P .fi .UNINDENT @@ -23076,7 +22995,7 @@ words, 1 uses the least CPU on the master (and minion), while 9 uses the most. .sp .nf .ft C -# salt \(aq*\(aq cp.get_file salt://vimrc /etc/vimrc gzip=5 +salt \(aq*\(aq cp.get_file salt://vimrc /etc/vimrc gzip=5 .ft P .fi .UNINDENT @@ -23090,7 +23009,7 @@ argument: .sp .nf .ft C -# salt \(aq*\(aq cp.get_file salt://vimrc /etc/vim/vimrc makedirs=True +salt \(aq*\(aq cp.get_file salt://vimrc /etc/vim/vimrc makedirs=True .ft P .fi .UNINDENT @@ -23106,7 +23025,7 @@ directory from the master. The syntax is very similar to get_file: .sp .nf .ft C -# salt \(aq*\(aq cp.get_dir salt://etc/apache2 /etc +salt \(aq*\(aq cp.get_dir salt://etc/apache2 /etc .ft P .fi .UNINDENT @@ -23119,7 +23038,7 @@ get_file: .sp .nf .ft C -# salt \(aq*\(aq cp.get_dir salt://etc/{{pillar.webserver}} /etc gzip=5 template=jinja +salt \(aq*\(aq cp.get_dir salt://etc/{{pillar.webserver}} /etc gzip=5 template=jinja .ft P .fi .UNINDENT @@ -32001,6 +31920,7 @@ splunk_http_forwarder: indexer: sourcetype: index: + verify_ssl: true .ft P .fi .UNINDENT @@ -32011,7 +31931,7 @@ Run a test by using \fBsalt\-call test.ping \-\-return splunk\fP Written by Scott Pack (github.com/scottjpack) .INDENT 0.0 .TP -.B class salt.returners.splunk.http_event_collector(token, http_event_server, host=\(aq\(aq, http_event_port=\(aq8088\(aq, http_event_server_ssl=True, max_bytes=100000) +.B class salt.returners.splunk.http_event_collector(token, http_event_server, host=\(aq\(aq, http_event_port=\(aq8088\(aq, http_event_server_ssl=True, max_bytes=100000, verify_ssl=True) .INDENT 7.0 .TP .B batchEvent(payload, eventtime=\(aq\(aq) @@ -40699,7 +40619,7 @@ New in version 2017.7.0. New in version 2018.3.0: Renamed from \fBjson_decode_list\fP to \fBjson_encode_list\fP\&. When you encode something you get bytes, and when you decode, you get your locale\(aqs encoding (usually a \fBunicode\fP type). This filter was incorrectly\-named -when it was added. \fBjson_decode_list\fP will be supported until the Aluminium +when it was added. \fBjson_decode_list\fP will be supported until the 3003 release. .sp @@ -40740,7 +40660,7 @@ New in version 2017.7.0. New in version 2018.3.0: Renamed from \fBjson_decode_dict\fP to \fBjson_encode_dict\fP\&. When you encode something you get bytes, and when you decode, you get your locale\(aqs encoding (usually a \fBunicode\fP type). This filter was incorrectly\-named -when it was added. \fBjson_decode_dict\fP will be supported until the Aluminium +when it was added. \fBjson_decode_dict\fP will be supported until the 3003 release. .sp @@ -45282,7 +45202,7 @@ such as Google Storage, S3 and OpenStack Swift .sp .nf .ft C -$ salt \(aq*\(aq libcloud_storage.download_object DeploymentTools test.sh /tmp/test.sh google_storage +salt \(aq*\(aq libcloud_storage.download_object DeploymentTools test.sh /tmp/test.sh google_storage .ft P .fi .UNINDENT @@ -59372,7 +59292,7 @@ is in root of the file roots, this will return ".". This is usually identical to \fIslspath\fP except in case of root\-level sls, where this will return a "\fI\&.\fP". .sp A Common use case for this variable is to generate relative salt urls like: -\&.. code\-block:: jinja +.. code\-block:: jinja .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 @@ -66771,7 +66691,7 @@ New\-NetFirewallRule \-Name "SMB445" \-DisplayName "SMB445" \-Protocol TCP \-Loc New\-NetFirewallRule \-Name "WINRM5986" \-DisplayName "WINRM5986" \-Protocol TCP \-LocalPort 5986 winrm quickconfig \-q -winrm set winrm/config/winrs \(aq@{MaxMemoryPerShellMB="300"}\(aq +winrm set winrm/config/winrs \(aq@{MaxMemoryPerShellMB="3003.1" }\(aq winrm set winrm/config \(aq@{MaxTimeoutms="1800000"}\(aq winrm set winrm/config/service/auth \(aq@{Basic="true"}\(aq @@ -75889,7 +75809,7 @@ string. The first \fBdisk_size\fP specified in the string or list will be the fi disk size assigned to the VM. .sp List Example: -\&.. code\-block:: yaml +.. code\-block:: yaml .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 @@ -75901,7 +75821,7 @@ disk_size: [\(aq100\(aq, \(aq20\(aq, \(aq20\(aq] .UNINDENT .sp String Example: -\&.. code\-block:: yaml +.. code\-block:: yaml .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 @@ -76019,7 +75939,7 @@ New in version 2015.8.1. .sp Example: -\&.. code\-block:: yaml +.. code\-block:: yaml .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 @@ -77762,12 +77682,12 @@ Enter the size of disk in GB .TP .B thin_provision Specifies whether the disk should be thin provisioned or not. Default is \fBthin_provision: False\fP\&. -\&.. versionadded:: 2016.3.0 +.. versionadded:: 2016.3.0 .TP .B eagerly_scrub Specifies whether the disk should be rewrite with zeros during thick provisioning or not. Default is \fBeagerly_scrub: False\fP\&. -\&.. versionadded:: 2018.3.0 +.. versionadded:: 2018.3.0 .TP .B controller Specify the SCSI controller label to which this disk should be attached. @@ -83716,7 +83636,8 @@ def package_list(): List "packages" by executing a command via ssh This function is called in response to the salt command - ..code\-block::bash + .. code\-block:: bash + salt target_minion pkg.list_pkgs """ @@ -88185,7 +88106,7 @@ localhost to avoid someone eavesdropping on the shared secret. See the documentation for cherrypy to setup the headers in your frontal. .sp -New in version Beryllium. +New in version 2015.8.0. .INDENT 0.0 .TP @@ -88386,6 +88307,12 @@ Send events covering process status T} _ T{ +\fBsalt_monitor\fP +T} T{ +A beacon to execute salt execution module functions. +T} +_ +T{ \fBsalt_proxy\fP T} T{ Beacon to manage and report the status of one or more salt proxy processes @@ -89803,6 +89730,46 @@ processes are running or stopped. .B salt.beacons.ps.validate(config) Validate the beacon configuration .UNINDENT +.SS salt.beacons.salt_monitor +.sp +A beacon to execute salt execution module functions. This beacon will fire only if the return data is "truthy". +The function return, funtion name and args and/or kwargs, will be passed as data in the event. +.sp +The configuration can accept a list of salt functions to execute every interval. +Make sure to allot enough time via \(aqinterval\(aq key to allow all salt functions to execute. +The salt functions will be executed sequentially. +.sp +The elements in list of functions can be either a simple string (with no arguments) or a dictionary with a single +key being the salt execution module and sub keys indicating args and / or kwargs. +.sp +See example config below. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +beacons: + salt_monitor: + \- salt_fun: + \- slsutil.renderer: + args: + \- salt://states/apache.sls + kwargs: + \- default_renderer: jinja + \- test.ping + \- interval: 3600 # seconds +.ft P +.fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B salt.beacons.salt_monitor.beacon(config) +.UNINDENT +.INDENT 0.0 +.TP +.B salt.beacons.salt_monitor.validate(config) +.UNINDENT .SS salt.beacons.salt_proxy .sp Beacon to manage and report the status of @@ -90677,7 +90644,7 @@ Store a key value. .sp Minion data cache plugin for Etcd key/value data store. .sp -New in version develop. +New in version 2018.3.0. .sp It is up to the system administrator to set up and configure the Etcd @@ -90816,7 +90783,7 @@ Return the epoch of the mtime for this cache file .sp Minion data cache plugin for MySQL database. .sp -New in version develop. +New in version 2018.3.0. .sp It is up to the system administrator to set up and configure the MySQL @@ -91954,7 +91921,7 @@ salt\-cloud \-a stop myminion .SS salt.cloud.clouds.clc .SS CenturyLink Cloud Module .sp -New in version Oyxgen. +New in version 2018.3. .sp The CLC cloud module allows you to manage CLC Via the CLC SDK. @@ -92745,6 +92712,7 @@ Create a single VM from a data dict .TP .B salt.cloud.clouds.dimensiondata.create_lb(kwargs=None, call=None) Create a load\-balancer configuration. +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -93229,8 +93197,6 @@ Detach a volume from an instance .TP .B salt.cloud.clouds.ec2.disable_detailed_monitoring(name, call=None) Enable/disable detailed monitoring on a node -.sp -CLI Example: .UNINDENT .INDENT 0.0 .TP @@ -93253,8 +93219,6 @@ salt\-cloud \-a disable_term_protect mymachine .TP .B salt.cloud.clouds.ec2.enable_detailed_monitoring(name, call=None) Enable/disable detailed monitoring on a node -.sp -CLI Example: .UNINDENT .INDENT 0.0 .TP @@ -94052,7 +94016,9 @@ salt\-cloud \-f create_lb gce name=lb region=us\-central1 ports=80 .INDENT 0.0 .TP .B salt.cloud.clouds.gce.create_network(kwargs=None, call=None) -\&... versionchanged:: 2017.7.0 +Changed in version 2017.7.0. + +.sp Create a GCE network. Must specify name and cidr. .sp CLI Example: @@ -94088,7 +94054,9 @@ salt\-cloud \-f create_snapshot gce name=snap1 disk_name=pd .INDENT 0.0 .TP .B salt.cloud.clouds.gce.create_subnetwork(kwargs=None, call=None) -\&... versionadded:: 2017.7.0 +New in version 2017.7.0. + +.sp Create a GCE Subnetwork. Must specify name, cidr, network, and region. .sp CLI Example: @@ -94225,7 +94193,9 @@ salt\-cloud \-f delete_snapshot gce name=disk\-snap\-1 .INDENT 0.0 .TP .B salt.cloud.clouds.gce.delete_subnetwork(kwargs=None, call=None) -\&... versionadded:: 2017.7.0 +New in version 2017.7.0. + +.sp Delete a GCE Subnetwork. Must specify name and region. .sp CLI Example: @@ -94348,6 +94318,9 @@ salt\-cloud \-a reboot myinstance .TP .B salt.cloud.clouds.gce.request_instance(vm_) Request a single GCE instance from a data dict. +.sp +Changed in version 2017.7.0. + .UNINDENT .INDENT 0.0 .TP @@ -94503,7 +94476,9 @@ salt\-cloud \-f show_snapshot gce name=mysnapshot .INDENT 0.0 .TP .B salt.cloud.clouds.gce.show_subnetwork(kwargs=None, call=None) -\&... versionadded:: 2017.7.0 +New in version 2017.7.0. + +.sp Show details of an existing GCE Subnetwork. Must specify name and region. .sp CLI Example: @@ -94740,20 +94715,28 @@ New in version 2015.8.0. List all available public IPs. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt\-cloud \-f list_public_ips +.ft P +.fi .UNINDENT .UNINDENT .sp To list unavailable (assigned) IPs, use: .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt\-cloud \-f list_public_ips state=assigned +.ft P +.fi .UNINDENT .UNINDENT .sp @@ -95562,6 +95545,9 @@ If \(aqwhat\(aq is volume then the item is a libvirt volume object. .B Returns none .UNINDENT +.sp +New in version 2017.7.3. + .UNINDENT .INDENT 0.0 .TP @@ -101591,6 +101577,7 @@ Return the VM\(aqs size object .TP .B salt.cloud.clouds.packet.list_nodes(call=None) Returns a list of devices, keeping only a brief listing. +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -101818,7 +101805,7 @@ The module requires ProfitBricks credentials to be supplied along with an existing virtual datacenter UUID where the server resources will reside. The server should also be assigned a public LAN, a private LAN, or both along with SSH key pairs. -\&... +... .sp Set up the cloud configuration at \fB/etc/salt/cloud.providers\fP or \fB/etc/salt/cloud.providers.d/profitbricks.conf\fP: @@ -102337,6 +102324,7 @@ Warn if dependencies aren\(aqt met. .TP .B salt.cloud.clouds.proxmox.get_resources_nodes(call=None, resFilter=None) Retrieve all hypervisors (nodes) available on this environment +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -103136,10 +103124,14 @@ Create a node. Destroy a node. Will check termination protection and warn if enabled. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt\-cloud \-\-destroy mymachine +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -103428,7 +103420,7 @@ Return a list of the VMs that are on the provider .UNINDENT .INDENT 0.0 .TP -.B salt.cloud.clouds.softlayer_hw.list_nodes_full(mask=\(aqmask[id, hostname, primaryIpAddress, primaryBackendIpAddress, processorPhysicalCoreAmount, memoryCount]\(aq, call=None) +.B salt.cloud.clouds.softlayer_hw.list_nodes_full(mask=\(aqmask[id, hostname, primaryIpAddress, primaryBackendIpAddress, processorPhysicalCoreAmount, memoryCount]\(aq, call=None) Return a list of the VMs that are on the provider .UNINDENT .INDENT 0.0 @@ -107135,6 +107127,10 @@ The source for parsing the syslog messages is taken from: \fI\%https://gist.github.com/leandrosilva/3651640#file\-xlog\-py\fP .INDENT 0.0 .TP +.B class salt.engines.junos_syslog.DatagramProtocol +.UNINDENT +.INDENT 0.0 +.TP .B salt.engines.junos_syslog.start(port=516, **kwargs) .UNINDENT .SS salt.engines.libvirt_events @@ -107259,6 +107255,9 @@ ssl, certifi .B platform all .UNINDENT +.sp +New in version 2016.3.0. + .sp To enable this engine the master and/or minion will need the following python libraries @@ -107357,6 +107356,9 @@ Listen to salt events and forward them to Logentries .sp An engine that reads messages from the salt event bus and pushes them onto a logstash endpoint. +.sp +New in version 2015.8.0. + .INDENT 0.0 .TP .B configuration @@ -107688,6 +107690,9 @@ reactor: .sp An engine that reads messages from the redis sentinel pubsub and sends reactor events based on the channels they are subscribed to. +.sp +New in version 2016.3.0. + .INDENT 0.0 .TP .B configuration @@ -107770,6 +107775,7 @@ presence of the \(aqtag\(aq key and its value. .sp If there is a data obj available, that will also be fired along with the tag. +.sp Example .sp Given the following json output from a script: @@ -107808,6 +107814,9 @@ on the event bus with the data obj as is. .SS salt.engines.slack .sp An engine that reads messages from Slack and can act on them +.sp +New in version 2016.3.0. + .INDENT 0.0 .TP .B depends @@ -108319,6 +108328,9 @@ have been recently connected and remove their keys if they have not been connected for a certain period of time. .sp Requires that the \fBminion_data_cache\fP option be enabled. +.sp +New in version 2017.7.0. + .INDENT 0.0 .TP .B configuration @@ -108457,6 +108469,9 @@ Directly calls the given function with arguments .SS salt.executors.docker .sp Docker executor module +.sp +New in version 2019.2.0. + .sp Used with the docker proxy minion. .INDENT 0.0 @@ -109611,7 +109626,7 @@ salt.utils, salt.module.cmdmod SmartOS .UNINDENT .sp -New in version nitrogen. +New in version 2017.7.0. .INDENT 0.0 .TP @@ -110037,6 +110052,19 @@ salt \-G \(aqusername:foobar\(aq test.ping .UNINDENT .sp Output: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +device1: + True +device2: + True +.ft P +.fi +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -110121,6 +110149,9 @@ Return NVMe NQN .SS salt.grains.nxos .sp Grains for Cisco NX\-OS minions +.sp +New in version 2016.11.0. + .sp For documentation on setting up the nxos proxy minion look in the documentation for \fBsalt.proxy.nxos\fP\&. @@ -110229,7 +110260,7 @@ salt.utils, salt.module.cmdmod SmartOS .UNINDENT .sp -New in version nitrogen. +New in version 2017.7.0. .INDENT 0.0 .TP @@ -111619,12 +111650,6 @@ Module for interacting with the GitHub v3 API. T} _ T{ -\fBglance\fP -T} T{ -Module for handling openstack glance calls. -T} -_ -T{ \fBglanceng\fP T} T{ Glance module for interacting with OpenStack Glance @@ -113908,6 +113933,9 @@ _ .TE .SS salt.modules.acme .SS ACME / Let\(aqs Encrypt module +.sp +New in version 2016.3. + .sp This module currently looks for certbot script in the $PATH as \- certbot, @@ -114010,7 +114038,7 @@ Dictionary with \(aqresult\(aq True/False/None, \(aqcomment\(aq and certificate\ expiry date (\(aqnot_after\(aq) .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -114027,7 +114055,7 @@ salt \(aqgitlab.example.com\(aq acme.cert dev.example.com "[gitlab.example.com]" .B salt.modules.acme.certs() Return a list of active certificates .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -114055,7 +114083,7 @@ The expiry date of a certificate in ISO format Expiry date in ISO format. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -114112,7 +114140,7 @@ the certificate information, the information will be retrieved as one big text block under the key \fBtext\fP using the openssl cli. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -114326,7 +114354,12 @@ Replaces members of the group with a provided list. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq group.members foo \(aquser1,user2,user3,...\(aq +.ft P +.fi .UNINDENT .UNINDENT .INDENT 7.0 @@ -115408,6 +115441,7 @@ Linux .TP .B salt.modules.apf.allow(ip, port=None) Add host (IP/FQDN) to allow_hosts.rules and immediately load new rule into firewall +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -115424,6 +115458,7 @@ salt \(aq*\(aq apf.allow 127.0.0.1 .TP .B salt.modules.apf.deny(ip) Add host (IP/FQDN) to deny_hosts.rules and immediately load new rule into firewall +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -115440,6 +115475,7 @@ salt \(aq*\(aq apf.deny 1.2.3.4 .TP .B salt.modules.apf.disable() Stop (flush) all firewall rules +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -115456,6 +115492,7 @@ salt \(aq*\(aq apf.disable .TP .B salt.modules.apf.enable() Load all firewall rules +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -115472,6 +115509,7 @@ salt \(aq*\(aq apf.enable .TP .B salt.modules.apf.refresh() Refresh & resolve dns names in trust rules +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -115488,6 +115526,7 @@ salt \(aq*\(aq apf.refresh .TP .B salt.modules.apf.reload() Stop (flush) & reload firewall rules +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -115504,6 +115543,7 @@ salt \(aq*\(aq apf.reload .TP .B salt.modules.apf.remove(ip) Remove host from [glob]*_hosts.rules and immediately remove rule from firewall +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -115520,6 +115560,7 @@ salt \(aq*\(aq apf.remove 1.2.3.4 .TP .B salt.modules.apf.running() Check apf status +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -115544,6 +115585,9 @@ minion, and it is using a different module (or gives an error similar to \fI\(aqpkg.install\(aq is not available\fP), see here\&. .UNINDENT .UNINDENT +.sp +New in version 2017.7.0. + .INDENT 0.0 .TP .B salt.modules.apkpkg.file_dict(*packages, **kwargs) @@ -115752,8 +115796,13 @@ then an empty string will be returned for that path. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq pkg.owns /usr/bin/apachectl salt \(aq*\(aq pkg.owns /usr/bin/apachectl /usr/bin/basename +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -116577,7 +116626,7 @@ New in version 2016.11.3. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -116824,7 +116873,7 @@ List prefetched packages downloaded by apt in the local disk. operate on a different root directory. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -117269,6 +117318,29 @@ salt \(aq*\(aq pkg.remove pkgs=\(aq["foo", "bar"]\(aq .UNINDENT .INDENT 0.0 .TP +.B salt.modules.aptpkg.services_need_restart(**kwargs) +New in version 3003. + +.sp +List services that use files which have been changed by the +package manager. It might be needed to restart them. +.sp +Requires checkrestart from the debian\-goodies package. +.sp +CLI Examples: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +salt \(aq*\(aq pkg.services_need_restart +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP .B salt.modules.aptpkg.set_selections(path=None, selection=None, clear=False, saltenv=\(aqbase\(aq) Change package state in the dpkg database. .sp @@ -119883,7 +119955,12 @@ Run hg as a user other than what the minion runs as CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq aws_sqs.create_queue +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -119951,7 +120028,12 @@ Run hg as a user other than what the minion runs as CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq aws_sqs.delete_queue +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -119976,7 +120058,12 @@ Run hg as a user other than what the minion runs as CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq aws_sqs.list_queues +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -120004,7 +120091,12 @@ Run hg as a user other than what the minion runs as CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq aws_sqs.queue_exists +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -123996,7 +124088,12 @@ Show all employees for this company. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion bamboohr.list_employees +.ft P +.fi .UNINDENT .UNINDENT .sp @@ -124010,9 +124107,14 @@ unique. CLI Examples: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion bamboohr.list_employees order_by=id salt myminion bamboohr.list_employees order_by=displayName salt myminion bamboohr.list_employees order_by=workEmail +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -124024,7 +124126,12 @@ Show all meta data fields for this company. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion bamboohr.list_meta_fields +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -124036,7 +124143,12 @@ Show all users for this company. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion bamboohr.list_users +.ft P +.fi .UNINDENT .UNINDENT .sp @@ -124050,8 +124162,13 @@ unique. CLI Examples: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion bamboohr.list_users order_by=id salt myminion bamboohr.list_users order_by=email +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -124063,7 +124180,12 @@ Show all employees for this company. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion bamboohr.show_employee 1138 +.ft P +.fi .UNINDENT .UNINDENT .sp @@ -124111,7 +124233,12 @@ If needed, a different set of fields may be specified, separated by commas: CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion bamboohr.show_employee 1138 displayName,dateOfBirth +.ft P +.fi .UNINDENT .UNINDENT .sp @@ -124127,10 +124254,15 @@ clear it for that employee. CLI Examples: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion bamboohr.update_employee 1138 nickname Curly salt myminion bamboohr.update_employee 1138 nickname \(aq\(aq salt myminion bamboohr.update_employee 1138 items=\(aq{"nickname": "Curly"} salt myminion bamboohr.update_employee 1138 items=\(aq{"nickname": ""} +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -124203,6 +124335,7 @@ dictionary or a list of their functions as well as their arguments. .UNINDENT .sp CLI Example: +.sp (example truncated for brevity) .INDENT 7.0 .INDENT 3.5 @@ -124301,13 +124434,16 @@ It\(aqs available in Linux mainline kernel since 3.10 \fI\%https://www.kernel.org/doc/Documentation/bcache.txt\fP .sp This module needs the bcache userspace tools to function. +.sp +New in version 2016.3.0. + .INDENT 0.0 .TP .B salt.modules.bcache.attach_(dev=None) Attach a backing devices to a cache set If no dev is given, all backing devices will be attached. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -124331,7 +124467,7 @@ bool or None if nuttin\(aq happened Create a backing device for attachment to a set. Because the block size must be the same, a cache set already needs to exist. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -124363,7 +124499,7 @@ salt \(aq*\(aq bcache.back_make sdc cache_mode=writeback attach=True Create BCache cache on a block device. If blkdiscard is available the entire device will be properly cleared in advance. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -124407,7 +124543,7 @@ Show or update config of a bcache device. .sp If no device is given, operate on the cache set itself. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -124436,7 +124572,7 @@ If no dev is given, all backing devices will be attached. Detaching a backing device will flush its write cache. This should leave the underlying device in a consistent state, but might take a while. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -124454,7 +124590,7 @@ salt \(aq*\(aq bcache.detach bcache1 .B salt.modules.bcache.device(dev, stats=False, config=False, internals=False, superblock=False) Check the state of a single bcache device .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -124486,7 +124622,7 @@ salt \(aq*\(aq bcache.device /dev/sdc stats=True .B salt.modules.bcache.start() Trigger a start of the full bcache system through udev. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -124503,7 +124639,7 @@ salt \(aq*\(aq bcache.start .B salt.modules.bcache.status(stats=False, config=False, internals=False, superblock=False, alldevs=False) Show the full status of the BCache system and optionally all its involved devices .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -124545,7 +124681,7 @@ no attempt at flushing will be done and the bcache device will seemingly \(aqdis .UNINDENT .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -124562,7 +124698,7 @@ salt \(aq*\(aq bcache.stop .B salt.modules.bcache.super_(dev) Read out BCache SuperBlock .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -124581,7 +124717,7 @@ salt \(aq*\(aq bcache.device /dev/sdc Return the bcache UUID of a block device. If no device is given, the Cache UUID is returned. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -125205,7 +125341,7 @@ be treated as delimiters i.e. \fBciphers=\(aqDEFAULT\e:!SSLv3\(aq\fP .UNINDENT .UNINDENT .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -125361,7 +125497,7 @@ source | source\-destination] [none | default | [enabled|disabled]:vlan1,vlan2,vlan3 ... ] .UNINDENT .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -125472,7 +125608,7 @@ The iControl REST password The name of the pool which will be deleted .UNINDENT .sp -CLI Example: +CLI Example .INDENT 7.0 .INDENT 3.5 .sp @@ -126153,7 +126289,7 @@ be treated as delimiters i.e. \fBciphers=\(aqDEFAULT\e:!SSLv3\(aq\fP .UNINDENT .UNINDENT .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -127230,7 +127366,7 @@ salt myminion boto3_elasticache.revoke_cache_security_group_ingress .sp Connection module for Amazon Elasticsearch Service .sp -New in version Natrium. +New in version 3001. .INDENT 0.0 .TP @@ -127334,7 +127470,7 @@ Dictionary with key \(aqresult\(aq and as value a boolean denoting success or fa Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .sp CLI Example: @@ -127370,7 +127506,7 @@ Upon success, also contains a key \(aqreponse\(aq with the current service softw Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -127420,7 +127556,7 @@ Upon success, also contains a key \(aqreponse\(aq with boolean result of the che Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .sp CLI Example: @@ -127617,7 +127753,7 @@ Upon success, also contains a key \(aqreponse\(aq with the domain status configu Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .sp CLI Example: @@ -127676,7 +127812,7 @@ Dictionary with key \(aqresult\(aq and as value a boolean denoting success or fa Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -127695,7 +127831,7 @@ Dictionary with key \(aqresult\(aq and as value a boolean denoting success or fa Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -127716,7 +127852,7 @@ Upon success, also contains a key \(aqreponse\(aq with the domain status informa Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -127738,7 +127874,7 @@ Upon success, also contains a key \(aqreponse\(aq with the current configuration Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -127760,7 +127896,7 @@ Upon success, also contains a key \(aqreponse\(aq with the list of domain status Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .sp CLI Example: @@ -127806,7 +127942,7 @@ Upon success, also contains a key \(aqreponse\(aq with the limits information. Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .sp CLI Example: @@ -127843,7 +127979,7 @@ Upon success, also contains a key \(aqreponse\(aq with the list of offerings inf Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -127871,7 +128007,7 @@ Version 1.9.174 of boto3 has a bug in that reserved_elasticsearch_instance_id is considered a required argument, even though the documentation says otherwise. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -127891,7 +128027,7 @@ Dictionary with key \(aqresult\(aq and as value a boolean denoting success or fa Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -127914,7 +128050,7 @@ Upon success, also contains a key \(aqreponse\(aq with a list of compatible vers Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -127938,7 +128074,7 @@ Upon success, also contains a key \(aqreponse\(aq with a list of upgrade histori Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -127963,7 +128099,7 @@ Upon success, also contains a key \(aqreponse\(aq with upgrade status informatio Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -127981,7 +128117,7 @@ Upon success, also contains a key \(aqreponse\(aq with a list of domain names. Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -128010,7 +128146,7 @@ Upon success, also contains a key \(aqreponse\(aq with a list of Elasticsearch i Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -128028,7 +128164,7 @@ Upon success, also contains a key \(aqreponse\(aq with a list of Elasticsearch v Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -128046,7 +128182,7 @@ Upon success, also contains a key \(aqreponse\(aq with a dict of tags. Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -128075,7 +128211,7 @@ Upon success, also contains a key \(aqreponse\(aq with purchase information. Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -128103,7 +128239,7 @@ Dictionary with key \(aqresult\(aq and as value a boolean denoting success or fa Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .sp CLI Example: @@ -128137,7 +128273,7 @@ Upon success, also contains a key \(aqreponse\(aq with service software informat Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -128290,7 +128426,7 @@ Upon success, also contains a key \(aqreponse\(aq with the domain configuration. Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .sp CLI Example: @@ -128356,7 +128492,7 @@ Upon success, also contains a key \(aqreponse\(aq with the domain configuration. Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .sp CLI Example: @@ -128389,7 +128525,7 @@ Dictionary with key \(aqresult\(aq and as value a boolean denoting success or fa Upon failure, also contains a key \(aqerror\(aq with the error message as value. .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .SS salt.modules.boto3_route53 @@ -128892,7 +129028,7 @@ Note that if you pass in Name without providing a value for PrivateZone (either False), CommandExecutionError can be raised in the case of both public and private zones matching the domain. XXX FIXME DOCU .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -129043,7 +129179,7 @@ boto3 .B salt.modules.boto3_sns.create_topic(Name, region=None, key=None, keyid=None, profile=None) Create an SNS topic. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -129060,7 +129196,7 @@ salt myminion boto3_sns.create_topic mytopic region=us\-east\-1 .B salt.modules.boto3_sns.delete_topic(TopicArn, region=None, key=None, keyid=None, profile=None) Delete an SNS topic. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -129077,7 +129213,7 @@ salt myminion boto3_sns.delete_topic mytopic region=us\-east\-1 .B salt.modules.boto3_sns.describe_topic(name, region=None, key=None, keyid=None, profile=None) Returns details about a specific SNS topic, specified by name or ARN. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -129094,7 +129230,7 @@ salt my_favorite_client boto3_sns.describe_topic a_sns_topic_of_my_choice .B salt.modules.boto3_sns.get_subscription_attributes(SubscriptionArn, region=None, key=None, keyid=None, profile=None) Returns all of the properties of a subscription. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -129112,7 +129248,7 @@ salt myminion boto3_sns.get_subscription_attributes somesubscription region=us\- Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -129129,7 +129265,7 @@ salt myminion boto3_sns.get_topic_attributes someTopic region=us\-west\-1 .B salt.modules.boto3_sns.list_subscriptions(region=None, key=None, keyid=None, profile=None) Returns a list of the requester\(aqs topics .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -129146,7 +129282,7 @@ salt myminion boto3_sns.list_subscriptions region=us\-east\-1 .B salt.modules.boto3_sns.list_subscriptions_by_topic(TopicArn, region=None, key=None, keyid=None, profile=None) Returns a list of the subscriptions to a specific topic .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -129163,7 +129299,7 @@ salt myminion boto3_sns.list_subscriptions_by_topic mytopic region=us\-east\-1 .B salt.modules.boto3_sns.list_topics(region=None, key=None, keyid=None, profile=None) Returns a list of the requester\(aqs topics .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -129180,7 +129316,7 @@ salt myminion boto3_sns.list_topics .B salt.modules.boto3_sns.set_subscription_attributes(SubscriptionArn, AttributeName, AttributeValue, region=None, key=None, keyid=None, profile=None) Set an attribute of a subscription to a new value. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -129197,7 +129333,7 @@ salt myminion boto3_sns.set_subscription_attributes someSubscription RawMessageD .B salt.modules.boto3_sns.set_topic_attributes(TopicArn, AttributeName, AttributeValue, region=None, key=None, keyid=None, profile=None) Set an attribute of a topic to a new value. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -129214,7 +129350,7 @@ salt myminion boto3_sns.set_topic_attributes someTopic DisplayName myDisplayName .B salt.modules.boto3_sns.subscribe(TopicArn, Protocol, Endpoint, region=None, key=None, keyid=None, profile=None) Subscribe to a Topic. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -129231,7 +129367,7 @@ salt myminion boto3_sns.subscribe mytopic https https://www.example.com/sns\-end .B salt.modules.boto3_sns.topic_exists(name, region=None, key=None, keyid=None, profile=None) Check to see if an SNS topic exists. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130526,7 +130662,7 @@ boto3 .B salt.modules.boto_asg.create(name, launch_config_name, availability_zones, min_size, max_size, desired_capacity=None, load_balancers=None, default_cooldown=None, health_check_type=None, health_check_period=None, placement_group=None, vpc_zone_identifier=None, tags=None, termination_policies=None, suspended_processes=None, scaling_policies=None, scheduled_actions=None, region=None, notification_arn=None, notification_types=None, key=None, keyid=None, profile=None) Create an autoscale group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130543,7 +130679,7 @@ salt myminion boto_asg.create myasg mylc \(aq["us\-east\-1a", "us\-east\-1e"]\(a .B salt.modules.boto_asg.create_launch_configuration(name, image_id, key_name=None, vpc_id=None, vpc_name=None, security_groups=None, user_data=None, instance_type=\(aqm1.small\(aq, kernel_id=None, ramdisk_id=None, block_device_mappings=None, instance_monitoring=False, spot_price=None, instance_profile_name=None, ebs_optimized=False, associate_public_ip_address=None, volume_type=None, delete_on_termination=True, iops=None, use_block_device_types=False, region=None, key=None, keyid=None, profile=None) Create a launch configuration. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130560,7 +130696,7 @@ salt myminion boto_asg.create_launch_configuration mylc image_id=ami\-0b9c9f62 k .B salt.modules.boto_asg.delete(name, force=False, region=None, key=None, keyid=None, profile=None) Delete an autoscale group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130577,7 +130713,7 @@ salt myminion boto_asg.delete myasg region=us\-east\-1 .B salt.modules.boto_asg.delete_launch_configuration(name, region=None, key=None, keyid=None, profile=None) Delete a launch configuration. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130594,7 +130730,7 @@ salt myminion boto_asg.delete_launch_configuration mylc .B salt.modules.boto_asg.describe_launch_configuration(name, region=None, key=None, keyid=None, profile=None) Dump details of a given launch configuration. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130614,7 +130750,7 @@ Switch desired instances to StandBy mode New in version 2016.11.0. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130631,7 +130767,7 @@ salt\-call boto_asg.enter_standby my_autoscale_group_name \(aq["i\-xxxxxx"]\(aq .B salt.modules.boto_asg.exists(name, region=None, key=None, keyid=None, profile=None) Check to see if an autoscale group exists. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130651,7 +130787,7 @@ Exit desired instances from StandBy mode New in version 2016.11.0. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130672,7 +130808,7 @@ Return all AutoScale Groups visible in the account New in version 2016.11.0. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130689,7 +130825,7 @@ salt\-call boto_asg.get_all_groups region=us\-east\-1 \-\-output yaml .B salt.modules.boto_asg.get_all_launch_configurations(region=None, key=None, keyid=None, profile=None) Fetch and return all Launch Configuration with details. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130724,7 +130860,7 @@ salt myminion boto.get_cloud_init_mime .B salt.modules.boto_asg.get_config(name, region=None, key=None, keyid=None, profile=None) Get the configuration for an autoscale group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130741,7 +130877,7 @@ salt myminion boto_asg.get_config myasg region=us\-east\-1 .B salt.modules.boto_asg.get_instances(name, lifecycle_state=\(aqInService\(aq, health_status=\(aqHealthy\(aq, attribute=\(aqprivate_ip_address\(aq, attributes=None, region=None, key=None, keyid=None, profile=None) return attribute of all instances in the named autoscale group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130777,7 +130913,7 @@ salt \(aq*\(aq boto_asg.get_scaling_policy_arn mygroup mypolicy .B salt.modules.boto_asg.launch_configuration_exists(name, region=None, key=None, keyid=None, profile=None) Check for a launch configuration\(aqs existence. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130798,7 +130934,7 @@ Return all AutoScale Groups visible in the account New in version 2016.11.0. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130815,7 +130951,7 @@ salt\-call boto_asg.list_groups region=us\-east\-1 .B salt.modules.boto_asg.list_launch_configurations(region=None, key=None, keyid=None, profile=None) List all Launch Configurations. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -130832,7 +130968,7 @@ salt myminion boto_asg.list_launch_configurations .B salt.modules.boto_asg.update(name, launch_config_name, availability_zones, min_size, max_size, desired_capacity=None, load_balancers=None, default_cooldown=None, health_check_type=None, health_check_period=None, placement_group=None, vpc_zone_identifier=None, tags=None, termination_policies=None, suspended_processes=None, scaling_policies=None, scheduled_actions=None, notification_arn=None, notification_types=None, region=None, key=None, keyid=None, profile=None) Update an autoscale group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -131685,10 +131821,15 @@ boto_asg.present state for an ASG with scaling_policies, and then set up boto_cloudwatch_alarm.present states which have alarm_actions that reference the scaling_policy. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion boto_cloudwatch.create_alarm name=myalarm ... region=us\-east\-1 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -131714,7 +131855,7 @@ salt myminion boto_cloudwatch.delete_alarm myalarm region=us\-east\-1 .B salt.modules.boto_cloudwatch.get_alarm(name, region=None, key=None, keyid=None, profile=None) Get alarm details. Also can be used to check to see if an alarm exists. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -131770,7 +131911,7 @@ $ diff final_alarms.sls managed_alarms.sls .UNINDENT .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -131920,7 +132061,7 @@ Given a rule name, check to see if the given rule exists. Returns True if the given rule exists and returns False if the given rule does not exist. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -131937,7 +132078,7 @@ salt myminion boto_cloudwatch_event.exists myevent region=us\-east\-1 .B salt.modules.boto_cloudwatch_event.list_rules(region=None, key=None, keyid=None, profile=None) List, with details, all Cloudwatch Event rules visible in the current scope. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -132288,7 +132429,7 @@ boto3 .B salt.modules.boto_datapipeline.activate_pipeline(pipeline_id, region=None, key=None, keyid=None, profile=None) Start processing pipeline tasks. This function is idempotent. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -132305,7 +132446,7 @@ salt myminion boto_datapipeline.activate_pipeline my_pipeline_id .B salt.modules.boto_datapipeline.create_pipeline(name, unique_id, description=\(aq\(aq, region=None, key=None, keyid=None, profile=None) Create a new, empty pipeline. This function is idempotent. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -132322,7 +132463,7 @@ salt myminion boto_datapipeline.create_pipeline my_name my_unique_id .B salt.modules.boto_datapipeline.delete_pipeline(pipeline_id, region=None, key=None, keyid=None, profile=None) Delete a pipeline, its pipeline definition, and its run history. This function is idempotent. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -132339,7 +132480,7 @@ salt myminion boto_datapipeline.delete_pipeline my_pipeline_id .B salt.modules.boto_datapipeline.describe_pipelines(pipeline_ids, region=None, key=None, keyid=None, profile=None) Retrieve metadata about one or more pipelines. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -132356,7 +132497,7 @@ salt myminion boto_datapipeline.describe_pipelines [\(aqmy_pipeline_id\(aq] .B salt.modules.boto_datapipeline.get_pipeline_definition(pipeline_id, version=\(aqlatest\(aq, region=None, key=None, keyid=None, profile=None) Get the definition of the specified pipeline. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -132390,7 +132531,7 @@ salt myminion boto_datapipeline.list_pipelines profile=myprofile .B salt.modules.boto_datapipeline.pipeline_id_from_name(name, region=None, key=None, keyid=None, profile=None) Get the pipeline id, if it exists, for the given name. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -132408,7 +132549,7 @@ salt myminion boto_datapipeline.pipeline_id_from_name my_pipeline_name Add tasks, schedules, and preconditions to the specified pipeline. This function is idempotent and will replace an existing definition. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -132497,11 +132638,15 @@ boto Creates a single global secondary index on a DynamoDB table. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion boto_dynamodb.create_global_secondary_index table_name / index_name +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -132551,7 +132696,7 @@ salt myminion boto_dynamodb.delete table_name region=us\-east\-1 .B salt.modules.boto_dynamodb.describe(table_name, region=None, key=None, keyid=None, profile=None) Describe a DynamoDB table. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -132585,10 +132730,17 @@ salt myminion boto_dynamodb.exists table_name region=us\-east\-1 .B salt.modules.boto_dynamodb.extract_index(index_data, global_index=False) Instantiates and returns an AllIndex object given a valid index configuration +.sp +CLI Example: .INDENT 7.0 -.TP -.B CLI Example: +.INDENT 3.5 +.sp +.nf +.ft C salt myminion boto_dynamodb.extract_index index +.ft P +.fi +.UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 @@ -132596,7 +132748,7 @@ salt myminion boto_dynamodb.extract_index index .B salt.modules.boto_dynamodb.update(table_name, throughput=None, global_indexes=None, region=None, key=None, keyid=None, profile=None) Update a DynamoDB table. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -132614,11 +132766,15 @@ salt myminion boto_dynamodb.update table_name region=us\-east\-1 Updates the throughput of the given global secondary indexes. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion boto_dynamodb.update_global_secondary_index table_name / indexes +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -132833,7 +132989,7 @@ salt myminion boto_ec2.attach_network_interface my_eni instance_name=salt\-maste .TP .B salt.modules.boto_ec2.attach_volume(volume_id, instance_id, device, region=None, key=None, keyid=None, profile=None) Attach an EBS volume to an EC2 instance. -\&.. +.. .INDENT 7.0 .TP .B volume_id @@ -133508,6 +133664,7 @@ salt myminion boto_ec2.get_id myinstance .B salt.modules.boto_ec2.get_key(key_name, region=None, key=None, keyid=None, profile=None) Check to see if a key exists. Returns fingerprint and name if it does and False if it doesn\(aqt +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -134523,7 +134680,7 @@ boto Authorize network ingress from an ec2 security group to a cache security group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134540,7 +134697,7 @@ salt myminion boto_elasticache.authorize_cache_security_group_ingress myelastica .B salt.modules.boto_elasticache.create(name, num_cache_nodes=None, engine=None, cache_node_type=None, replication_group_id=None, engine_version=None, cache_parameter_group_name=None, cache_subnet_group_name=None, cache_security_group_names=None, security_group_ids=None, snapshot_arns=None, preferred_availability_zone=None, preferred_maintenance_window=None, port=None, notification_topic_arn=None, auto_minor_version_upgrade=None, wait=None, region=None, key=None, keyid=None, profile=None) Create a cache cluster. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134558,7 +134715,7 @@ cache_security_group_names=\(aq["myelasticachesg"]\(aq .B salt.modules.boto_elasticache.create_cache_security_group(name, description, region=None, key=None, keyid=None, profile=None) Create a cache security group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134575,7 +134732,7 @@ salt myminion boto_elasticache.create_cache_security_group myelasticachesg \(aqM .B salt.modules.boto_elasticache.create_replication_group(name, primary_cluster_id, replication_group_description, wait=None, region=None, key=None, keyid=None, profile=None) Create replication group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134609,7 +134766,7 @@ salt myminion boto_elasticache.create_subnet_group my\-subnet\-group .B salt.modules.boto_elasticache.delete(name, wait=False, region=None, key=None, keyid=None, profile=None) Delete a cache cluster. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134626,7 +134783,7 @@ salt myminion boto_elasticache.delete myelasticache .B salt.modules.boto_elasticache.delete_cache_security_group(name, region=None, key=None, keyid=None, profile=None) Delete a cache security group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134643,7 +134800,7 @@ salt myminion boto_elasticache.delete_cache_security_group myelasticachesg \(aqM .B salt.modules.boto_elasticache.delete_replication_group(name, region=None, key=None, keyid=None, profile=None) Delete an ElastiCache replication group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134660,7 +134817,7 @@ salt myminion boto_elasticache.delete_replication_group my\-replication\-group .B salt.modules.boto_elasticache.delete_subnet_group(name, region=None, key=None, keyid=None, profile=None) Delete an ElastiCache subnet group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134677,7 +134834,7 @@ salt myminion boto_elasticache.delete_subnet_group my\-subnet\-group .B salt.modules.boto_elasticache.describe_replication_group(name, region=None, key=None, keyid=None, profile=None, parameter=None) Get replication group information. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134694,7 +134851,7 @@ salt myminion boto_elasticache.describe_replication_group mygroup .B salt.modules.boto_elasticache.exists(name, region=None, key=None, keyid=None, profile=None) Check to see if a cache cluster exists. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134711,7 +134868,7 @@ salt myminion boto_elasticache.exists myelasticache .B salt.modules.boto_elasticache.get_all_cache_subnet_groups(name=None, region=None, key=None, keyid=None, profile=None) Return a list of all cache subnet groups with details .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134728,7 +134885,7 @@ salt myminion boto_elasticache.get_all_subnet_groups region=us\-east\-1 .B salt.modules.boto_elasticache.get_cache_subnet_group(name, region=None, key=None, keyid=None, profile=None) Get information about a cache subnet group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134745,7 +134902,7 @@ salt myminion boto_elasticache.get_cache_subnet_group mycache_subnet_group .B salt.modules.boto_elasticache.get_config(name, region=None, key=None, keyid=None, profile=None) Get the configuration for a cache cluster. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134762,7 +134919,7 @@ salt myminion boto_elasticache.get_config myelasticache .B salt.modules.boto_elasticache.get_group_host(name, region=None, key=None, keyid=None, profile=None) Get hostname from replication cache group .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134779,7 +134936,7 @@ salt myminion boto_elasticache.get_group_host myelasticachegroup .B salt.modules.boto_elasticache.get_node_host(name, region=None, key=None, keyid=None, profile=None) Get hostname from cache node .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134796,7 +134953,7 @@ salt myminion boto_elasticache.get_node_host myelasticache .B salt.modules.boto_elasticache.group_exists(name, region=None, key=None, keyid=None, profile=None) Check to see if a replication group exists. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134813,7 +134970,7 @@ salt myminion boto_elasticache.group_exists myelasticache .B salt.modules.boto_elasticache.list_cache_subnet_groups(name=None, region=None, key=None, keyid=None, profile=None) Return a list of all cache subnet group names .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134831,7 +134988,7 @@ salt myminion boto_elasticache.list_subnet_groups region=us\-east\-1 Revoke network ingress from an ec2 security group to a cache security group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -134848,7 +135005,7 @@ salt myminion boto_elasticache.revoke_cache_security_group_ingress myelasticache .B salt.modules.boto_elasticache.subnet_group_exists(name, tags=None, region=None, key=None, keyid=None, profile=None) Check to see if an ElastiCache subnet group exists. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135267,7 +135424,7 @@ boto >= 2.33.0 .B salt.modules.boto_elb.apply_security_groups(name, security_groups, region=None, key=None, keyid=None, profile=None) Apply security groups to ELB. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135284,7 +135441,7 @@ salt myminion boto_elb.apply_security_groups myelb \(aq["mysecgroup1"]\(aq .B salt.modules.boto_elb.attach_subnets(name, subnets, region=None, key=None, keyid=None, profile=None) Attach ELB to subnets. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135318,7 +135475,7 @@ salt myminion boto_elb.create myelb \(aq["us\-east\-1a", "us\-east\-1e"]\(aq \(a .B salt.modules.boto_elb.create_listeners(name, listeners, region=None, key=None, keyid=None, profile=None) Create listeners on an ELB. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135338,7 +135495,7 @@ Create an ELB policy. New in version 2016.3.0. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135372,7 +135529,7 @@ salt myminion boto_elb.delete myelb region=us\-east\-1 .B salt.modules.boto_elb.delete_listeners(name, ports, region=None, key=None, keyid=None, profile=None) Delete listeners on an ELB. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135392,7 +135549,7 @@ Delete an ELB policy. New in version 2016.3.0. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135445,7 +135602,7 @@ Returns: \fBNone\fP: instance(s) not valid or not registered, no action taken .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135463,7 +135620,7 @@ salt myminion boto_elb.deregister_instances myelb "[instance_id, instance_id]" .B salt.modules.boto_elb.detach_subnets(name, subnets, region=None, key=None, keyid=None, profile=None) Detach ELB from subnets. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135480,7 +135637,7 @@ salt myminion boto_elb.detach_subnets myelb \(aq["mysubnet"]\(aq .B salt.modules.boto_elb.disable_availability_zones(name, availability_zones, region=None, key=None, keyid=None, profile=None) Disable availability zones for ELB. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135497,7 +135654,7 @@ salt myminion boto_elb.disable_availability_zones myelb \(aq["us\-east\-1a"]\(aq .B salt.modules.boto_elb.enable_availability_zones(name, availability_zones, region=None, key=None, keyid=None, profile=None) Enable availability zones for ELB. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135514,7 +135671,7 @@ salt myminion boto_elb.enable_availability_zones myelb \(aq["us\-east\-1a"]\(aq .B salt.modules.boto_elb.exists(name, region=None, key=None, keyid=None, profile=None) Check to see if an ELB exists. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135531,7 +135688,7 @@ salt myminion boto_elb.exists myelb region=us\-east\-1 .B salt.modules.boto_elb.get_all_elbs(region=None, key=None, keyid=None, profile=None) Return all load balancers associated with an account .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135548,7 +135705,7 @@ salt myminion boto_elb.get_all_elbs region=us\-east\-1 .B salt.modules.boto_elb.get_attributes(name, region=None, key=None, keyid=None, profile=None) Check to see if attributes are set on an ELB. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135565,7 +135722,7 @@ salt myminion boto_elb.get_attributes myelb .B salt.modules.boto_elb.get_elb_config(name, region=None, key=None, keyid=None, profile=None) Get an ELB configuration. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135582,7 +135739,7 @@ salt myminion boto_elb.exists myelb region=us\-east\-1 .B salt.modules.boto_elb.get_health_check(name, region=None, key=None, keyid=None, profile=None) Get the health check configured for this ELB. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135599,7 +135756,7 @@ salt myminion boto_elb.get_health_check myelb .B salt.modules.boto_elb.get_instance_health(name, region=None, key=None, keyid=None, profile=None, instances=None) Get a list of instances and their health state .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135617,7 +135774,7 @@ salt myminion boto_elb.get_instance_health myelb region=us\-east\-1 instances="[ .B salt.modules.boto_elb.list_elbs(region=None, key=None, keyid=None, profile=None) Return names of all load balancers associated with an account .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135635,7 +135792,7 @@ salt myminion boto_elb.list_elbs region=us\-east\-1 Convert an ELB listener dict into a listener tuple used by certain parts of the AWS ELB API. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135661,7 +135818,7 @@ Returns: \fBFalse\fP: instance(s) failed to be registered .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135744,10 +135901,15 @@ salt myminion boto_elb.set_attributes myelb \(aq{"access_log": {"enabled": "true .B salt.modules.boto_elb.set_backend_policy(name, port, policies=None, region=None, key=None, keyid=None, profile=None) Set the policies of an ELB backend server. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion boto_elb.set_backend_policy myelb 443 "[policy1,policy2]" +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -135773,7 +135935,7 @@ salt myminion boto_elb.set_health_check myelb \(aq{"target": "HTTP:80/"}\(aq .B salt.modules.boto_elb.set_instances(name, instances, test=False, region=None, key=None, keyid=None, profile=None) Set the instances assigned to an ELB to exactly the list given .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135793,7 +135955,7 @@ Set the policies of an ELB listener. New in version 2016.3.0. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135945,11 +136107,15 @@ considering a target unhealthy. The default is 2. (bool) \- True on success, False on failure. .UNINDENT .sp -CLI example: -\&.. code\-block:: bash +CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion boto_elbv2.create_target_group learn1give1 protocol=HTTP port=54006 vpc_id=vpc\-deadbeef +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -135966,7 +136132,7 @@ Delete target group. (bool) \- True on success, False on failure. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -135992,7 +136158,7 @@ Returns: \fBFalse\fP: instance(s) failed to be deregistered .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -136010,7 +136176,7 @@ salt myminion boto_elbv2.deregister_targets myelb "[instance_id,instance_id]" .B salt.modules.boto_elbv2.describe_target_health(name, targets=None, region=None, key=None, keyid=None, profile=None) Get the curret health check status for targets in a target group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -136036,7 +136202,7 @@ Returns: \fBFalse\fP: instance(s) failed to be registered .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -136054,7 +136220,7 @@ salt myminion boto_elbv2.register_targets myelb "[instance_id,instance_id]" .B salt.modules.boto_elbv2.target_group_exists(name, region=None, key=None, keyid=None, profile=None) Check to see if an target group exists. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -136467,16 +136633,11 @@ CLI Example: .sp .nf .ft C -\&.. code\-block:: bash +salt myminion boto_iam.delete_group mygroup .ft P .fi .UNINDENT .UNINDENT -.INDENT 7.0 -.INDENT 3.5 -salt myminion boto_iam.delete_group mygroup -.UNINDENT -.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -136489,16 +136650,11 @@ CLI Example: .sp .nf .ft C -\&.. code\-block:: bash +salt myminion boto_iam.delete_group_policy mygroup mypolicy .ft P .fi .UNINDENT .UNINDENT -.INDENT 7.0 -.INDENT 3.5 -salt myminion boto_iam.delete_group_policy mygroup mypolicy -.UNINDENT -.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -136790,7 +136946,12 @@ sls file. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt\-call boto_iam.export_roles \-\-out=txt | sed "s/local: //" > iam_roles.sls +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -136806,7 +136967,12 @@ New in version 2016.3.0. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt\-call boto_iam.export_users \-\-out=txt | sed "s/local: //" > iam_users.sls +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -136895,7 +137061,12 @@ New in version 2016.3.0. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt\-call boto_iam.get_all_groups +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -136910,7 +137081,12 @@ New in version 2016.11.0. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt\-call boto_iam.get_all_instance_profiles +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -136945,7 +137121,12 @@ New in version 2016.3.0. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt\-call boto_iam.get_all_roles +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -136980,7 +137161,12 @@ New in version 2016.3.0. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt\-call boto_iam.get_all_users +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -137285,7 +137471,12 @@ New in version 2016.11.0. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt\-call boto_iam.list_instance_profiles +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -138356,7 +138547,7 @@ boto3 .B salt.modules.boto_kinesis.create_stream(stream_name, num_shards, region=None, key=None, keyid=None, profile=None) Create a stream with name stream_name and initial number of shards num_shards. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138373,7 +138564,7 @@ salt myminion boto_kinesis.create_stream my_stream N region=us\-east\-1 .B salt.modules.boto_kinesis.decrease_stream_retention_period(stream_name, retention_hours, region=None, key=None, keyid=None, profile=None) Decrease stream retention period to retention_hours .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138390,7 +138581,7 @@ salt myminion boto_kinesis.decrease_stream_retention_period my_stream N region=u .B salt.modules.boto_kinesis.delete_stream(stream_name, region=None, key=None, keyid=None, profile=None) Delete the stream with name stream_name. This cannot be undone! All data will be lost!! .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138407,7 +138598,7 @@ salt myminion boto_kinesis.delete_stream my_stream region=us\-east\-1 .B salt.modules.boto_kinesis.disable_enhanced_monitoring(stream_name, metrics, region=None, key=None, keyid=None, profile=None) Disable enhanced monitoring for the specified shard\-level metrics on stream stream_name .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138424,7 +138615,7 @@ salt myminion boto_kinesis.disable_enhanced_monitoring my_stream ["metrics", "to .B salt.modules.boto_kinesis.enable_enhanced_monitoring(stream_name, metrics, region=None, key=None, keyid=None, profile=None) Enable enhanced monitoring for the specified shard\-level metrics on stream stream_name .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138441,7 +138632,7 @@ salt myminion boto_kinesis.enable_enhanced_monitoring my_stream ["metrics", "to" .B salt.modules.boto_kinesis.exists(stream_name, region=None, key=None, keyid=None, profile=None) Check if the stream exists. Returns False and the error if it does not. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138460,7 +138651,7 @@ Collect some data: number of open shards, key range, etc. Modifies stream_details to add a sorted list of OpenShards. Returns (min_hash_key, max_hash_key, stream_details) .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138479,7 +138670,7 @@ Get complete stream info from AWS, returning only when the stream is in the ACTI Continues to retry when stream is updating or creating. If the stream is deleted during retries, the loop will catch the error and break. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138496,7 +138687,7 @@ salt myminion boto_kinesis.get_stream_when_active my_stream region=us\-east\-1 .B salt.modules.boto_kinesis.increase_stream_retention_period(stream_name, retention_hours, region=None, key=None, keyid=None, profile=None) Increase stream retention period to retention_hours .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138513,7 +138704,7 @@ salt myminion boto_kinesis.increase_stream_retention_period my_stream N region=u .B salt.modules.boto_kinesis.list_streams(region=None, key=None, keyid=None, profile=None) Return a list of all streams visible to the current account .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138532,7 +138723,7 @@ The hash key is a 128\-bit int, sent as a string. It\(aqs necessary to convert to int/long for comparison operations. This helper method handles python 2/3 incompatibility .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138558,7 +138749,7 @@ with the assumption that the ultimate goal is a balanced partition space. .sp For safety, user must past in force=True; otherwise, the function will dry run. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138649,7 +138840,7 @@ boto .B salt.modules.boto_kms.create_alias(alias_name, target_key_id, region=None, key=None, keyid=None, profile=None) Create a display name for a key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138667,7 +138858,7 @@ salt myminion boto_kms.create_alias \(aqalias/mykey\(aq key_id Adds a grant to a key to specify who can access the key and under what conditions. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138684,7 +138875,7 @@ salt myminion boto_kms.create_grant \(aqalias/mykey\(aq \(aqarn:aws:iam::1111111 .B salt.modules.boto_kms.create_key(policy=None, description=None, key_usage=None, region=None, key=None, keyid=None, profile=None) Creates a master key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138701,7 +138892,7 @@ salt myminion boto_kms.create_key \(aq{"Statement":...}\(aq "My master key" .B salt.modules.boto_kms.decrypt(ciphertext_blob, encryption_context=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None) Decrypt ciphertext. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138718,7 +138909,7 @@ salt myminion boto_kms.decrypt encrypted_ciphertext .B salt.modules.boto_kms.describe_key(key_id, region=None, key=None, keyid=None, profile=None) Get detailed information about a key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138735,7 +138926,7 @@ salt myminion boto_kms.describe_key \(aqalias/mykey\(aq .B salt.modules.boto_kms.disable_key(key_id, region=None, key=None, keyid=None, profile=None) Mark key as disabled. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138752,7 +138943,7 @@ salt myminion boto_kms.disable_key \(aqalias/mykey\(aq .B salt.modules.boto_kms.disable_key_rotation(key_id, region=None, key=None, keyid=None, profile=None) Disable key rotation for specified key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138769,7 +138960,7 @@ salt myminion boto_kms.disable_key_rotation \(aqalias/mykey\(aq .B salt.modules.boto_kms.enable_key(key_id, region=None, key=None, keyid=None, profile=None) Mark key as enabled. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138786,7 +138977,7 @@ salt myminion boto_kms.enable_key \(aqalias/mykey\(aq .B salt.modules.boto_kms.enable_key_rotation(key_id, region=None, key=None, keyid=None, profile=None) Disable key rotation for specified key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138803,7 +138994,7 @@ salt myminion boto_kms.enable_key_rotation \(aqalias/mykey\(aq .B salt.modules.boto_kms.encrypt(key_id, plaintext, encryption_context=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None) Encrypt plaintext into cipher text using specified key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138820,7 +139011,7 @@ salt myminion boto_kms.encrypt \(aqalias/mykey\(aq \(aqmyplaindata\(aq \(aq{"aws .B salt.modules.boto_kms.generate_data_key(key_id, encryption_context=None, number_of_bytes=None, key_spec=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None) Generate a secure data key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138837,7 +139028,7 @@ salt myminion boto_kms.generate_data_key \(aqalias/mykey\(aq number_of_bytes=102 .B salt.modules.boto_kms.generate_data_key_without_plaintext(key_id, encryption_context=None, number_of_bytes=None, key_spec=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None) Generate a secure data key without a plaintext copy of the key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138854,7 +139045,7 @@ salt myminion boto_kms.generate_data_key_without_plaintext \(aqalias/mykey\(aq n .B salt.modules.boto_kms.generate_random(number_of_bytes=None, region=None, key=None, keyid=None, profile=None) Generate a random string. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138871,7 +139062,7 @@ salt myminion boto_kms.generate_random number_of_bytes=1024 .B salt.modules.boto_kms.get_key_policy(key_id, policy_name, region=None, key=None, keyid=None, profile=None) Get the policy for the specified key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138888,7 +139079,7 @@ salt myminion boto_kms.get_key_policy \(aqalias/mykey\(aq mypolicy .B salt.modules.boto_kms.get_key_rotation_status(key_id, region=None, key=None, keyid=None, profile=None) Get status of whether or not key rotation is enabled for a key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138905,7 +139096,7 @@ salt myminion boto_kms.get_key_rotation_status \(aqalias/mykey\(aq .B salt.modules.boto_kms.key_exists(key_id, region=None, key=None, keyid=None, profile=None) Check for the existence of a key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138922,7 +139113,7 @@ salt myminion boto_kms.key_exists \(aqalias/mykey\(aq .B salt.modules.boto_kms.list_grants(key_id, limit=None, marker=None, region=None, key=None, keyid=None, profile=None) List grants for the specified key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138939,7 +139130,7 @@ salt myminion boto_kms.list_grants \(aqalias/mykey\(aq .B salt.modules.boto_kms.list_key_policies(key_id, limit=None, marker=None, region=None, key=None, keyid=None, profile=None) List key_policies for the specified key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138956,7 +139147,7 @@ salt myminion boto_kms.list_key_policies \(aqalias/mykey\(aq .B salt.modules.boto_kms.put_key_policy(key_id, policy_name, policy, region=None, key=None, keyid=None, profile=None) Attach a key policy to the specified key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138973,7 +139164,7 @@ salt myminion boto_kms.put_key_policy \(aqalias/mykey\(aq default \(aq{"Statemen .B salt.modules.boto_kms.re_encrypt(ciphertext_blob, destination_key_id, source_encryption_context=None, destination_encryption_context=None, grant_tokens=None, region=None, key=None, keyid=None, profile=None) Reencrypt encrypted data with a new master key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -138990,7 +139181,7 @@ salt myminion boto_kms.re_encrypt \(aqencrypted_data\(aq \(aqalias/mynewkey\(aq .B salt.modules.boto_kms.revoke_grant(key_id, grant_id, region=None, key=None, keyid=None, profile=None) Revoke a grant from a key. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -139007,7 +139198,7 @@ salt myminion boto_kms.revoke_grant \(aqalias/mykey\(aq 8u89hf\-j09j... .B salt.modules.boto_kms.update_key_description(key_id, description, region=None, key=None, keyid=None, profile=None) Update a key\(aqs description. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -139791,7 +139982,7 @@ salt myminion boto_rds.create_subnet_group my\-subnet\-group "group .B salt.modules.boto_rds.delete(name, skip_final_snapshot=None, final_db_snapshot_identifier=None, region=None, key=None, keyid=None, profile=None, tags=None, wait_for_deletion=True, timeout=180) Delete an RDS instance. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -139808,7 +139999,7 @@ salt myminion boto_rds.delete myrds skip_final_snapshot=True reg .B salt.modules.boto_rds.delete_option_group(name, region=None, key=None, keyid=None, profile=None) Delete an RDS option group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -139825,7 +140016,7 @@ salt myminion boto_rds.delete_option_group my\-opt\-group region .B salt.modules.boto_rds.delete_parameter_group(name, region=None, key=None, keyid=None, profile=None) Delete an RDS parameter group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -139842,7 +140033,7 @@ salt myminion boto_rds.delete_parameter_group my\-param\-group r .B salt.modules.boto_rds.delete_subnet_group(name, region=None, key=None, keyid=None, profile=None) Delete an RDS subnet group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -139859,7 +140050,7 @@ salt myminion boto_rds.delete_subnet_group my\-subnet\-group reg .B salt.modules.boto_rds.describe(name, tags=None, region=None, key=None, keyid=None, profile=None) Return RDS instance details. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -139878,7 +140069,7 @@ Return a detailed listing of some, or all, DB Instances visible in the current scope. Arbitrary subelements or subsections of the returned dataset can be selected by passing in a valid JMSEPath filter as well. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -139897,7 +140088,7 @@ Return a detailed listing of some, or all, DB Subnet Groups visible in the current scope. Arbitrary subelements or subsections of the returned dataset can be selected by passing in a valid JMSEPath filter as well. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -139946,7 +140137,7 @@ salt myminion boto_rds.describe_parameters parametergroupname region= .B salt.modules.boto_rds.exists(name, tags=None, region=None, key=None, keyid=None, profile=None) Check to see if an RDS exists. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -139963,7 +140154,7 @@ salt myminion boto_rds.exists myrds region=us\-east\-1 .B salt.modules.boto_rds.get_endpoint(name, tags=None, region=None, key=None, keyid=None, profile=None) Return the endpoint of an RDS instance. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -139996,7 +140187,7 @@ salt myminion boto_rds.modify_db_instance db_instance_identifier region=us\-east .B salt.modules.boto_rds.option_group_exists(name, tags=None, region=None, key=None, keyid=None, profile=None) Check to see if an RDS option group exists. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -140013,7 +140204,7 @@ salt myminion boto_rds.option_group_exists myoptiongr region=us\-east\-1 .B salt.modules.boto_rds.parameter_group_exists(name, tags=None, region=None, key=None, keyid=None, profile=None) Check to see if an RDS parameter group exists. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -140030,7 +140221,7 @@ salt myminion boto_rds.parameter_group_exists myparametergroup r .B salt.modules.boto_rds.subnet_group_exists(name, tags=None, region=None, key=None, keyid=None, profile=None) Check to see if an RDS subnet group exists. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -140047,7 +140238,7 @@ salt myminion boto_rds.subnet_group_exists my\-param\-group regi .B salt.modules.boto_rds.update_parameter_group(name, parameters, apply_method=\(aqpending\-reboot\(aq, tags=None, region=None, key=None, keyid=None, profile=None) Update an RDS parameter group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -140138,7 +140329,7 @@ boto .INDENT 3.5 Add a record to a zone. .sp -CLI example: +CLI Example: .INDENT 0.0 .INDENT 3.5 .sp @@ -140406,7 +140597,7 @@ salt myminion boto_route53.create_zone example.org .INDENT 3.5 Modify a record in a zone. .sp -CLI example: +CLI Example: .INDENT 0.0 .INDENT 3.5 .sp @@ -140512,7 +140703,7 @@ salt myminion boto_route53.describe_hosted_zones domain_name=foo.bar.com. .INDENT 3.5 Get a record from a zone. .sp -CLI example: +CLI Example: .INDENT 0.0 .INDENT 3.5 .sp @@ -140621,7 +140812,7 @@ salt myminion boto_route53.list_all_zones_by_name .INDENT 3.5 Modify a record in a zone. .sp -CLI example: +CLI Example: .INDENT 0.0 .INDENT 3.5 .sp @@ -141531,7 +141722,7 @@ boto .B salt.modules.boto_secgroup.authorize(name=None, source_group_name=None, source_group_owner_id=None, ip_protocol=None, from_port=None, to_port=None, cidr_ip=None, group_id=None, source_group_group_id=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None, egress=False) Add a new rule to an existing security group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -141549,7 +141740,7 @@ salt myminion boto_secgroup.authorize mysecgroup ip_protocol=tcp from_port=80 to Given a list of security groups and a vpc_id, convert_to_group_ids will convert all list items in the given list to security group ids. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -141566,7 +141757,7 @@ salt myminion boto_secgroup.convert_to_group_ids mysecgroup vpc\-89yhh7h .B salt.modules.boto_secgroup.create(name, description, vpc_id=None, vpc_name=None, region=None, key=None, keyid=None, profile=None) Create a security group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -141583,7 +141774,7 @@ salt myminion boto_secgroup.create mysecgroup \(aqMy Security Group\(aq .B salt.modules.boto_secgroup.delete(name=None, group_id=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None) Delete a security group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -141632,7 +141823,7 @@ amazon keyid amazon profile .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -141649,7 +141840,7 @@ salt myminion boto_secgroup.delete_tags [\(aqTAG_TO_DELETE1\(aq,\(aqTAG_TO_DELET .B salt.modules.boto_secgroup.exists(name=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None, group_id=None) Check to see if a security group exists. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -141674,7 +141865,7 @@ VPCs you\(aqll want to use the \fBgroup\-name\fP filter instead. The valid keys for the \fBfilters\fP argument can be found in \fI\%AWS\(aqs API documentation\fP\&. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -141691,7 +141882,7 @@ salt myminion boto_secgroup.get_all_security_groups filters=\(aq{group\-name: my .B salt.modules.boto_secgroup.get_config(name=None, group_id=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None) Get the configuration for a security group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -141708,7 +141899,7 @@ salt myminion boto_secgroup.get_config mysecgroup .B salt.modules.boto_secgroup.get_group_id(name, vpc_id=None, vpc_name=None, region=None, key=None, keyid=None, profile=None) Get a Group ID given a Group Name or Group Name and VPC ID .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -141725,7 +141916,7 @@ salt myminion boto_secgroup.get_group_id mysecgroup .B salt.modules.boto_secgroup.revoke(name=None, source_group_name=None, source_group_owner_id=None, ip_protocol=None, from_port=None, to_port=None, cidr_ip=None, group_id=None, source_group_group_id=None, region=None, key=None, keyid=None, profile=None, vpc_id=None, vpc_name=None, egress=False) Remove a rule from an existing security group. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -141774,7 +141965,7 @@ amazon keyid amazon profile .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -141893,7 +142084,7 @@ salt myminion boto_sns.delete mytopic region=us\-east\-1 .B salt.modules.boto_sns.exists(name, region=None, key=None, keyid=None, profile=None) Check to see if an SNS topic exists. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -141927,7 +142118,7 @@ salt myminion boto_sns.get_all_subscriptions_by_topic mytopic region=us\-east\-1 .B salt.modules.boto_sns.get_all_topics(region=None, key=None, keyid=None, profile=None) Returns a list of the all topics.. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -141944,7 +142135,7 @@ salt myminion boto_sns.get_all_topics .B salt.modules.boto_sns.get_arn(name, region=None, key=None, keyid=None, profile=None) Returns the full ARN for a given topic name. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -143162,7 +143353,7 @@ salt myminion boto_vpc.describe vpc_name=myvpc .UNINDENT .INDENT 0.0 .TP -.B salt.modules.boto_vpc.describe_nat_gateways(nat_gateway_id=None, subnet_id=None, subnet_name=None, vpc_id=None, vpc_name=None, states=(\(aqpending\(aq, \(aqavailable\(aq), region=None, key=None, keyid=None, profile=None) +.B salt.modules.boto_vpc.describe_nat_gateways(nat_gateway_id=None, subnet_id=None, subnet_name=None, vpc_id=None, vpc_name=None, states=\(aqpending\(aq, \(aqavailable\(aq, region=None, key=None, keyid=None, profile=None) Return a description of nat gateways matching the selection criteria .sp This function requires boto3 to be installed. @@ -143560,7 +143751,7 @@ salt myminion boto_vpc.is_peering_connection_pending conn_id=pcx\-8a8939e3 .UNINDENT .INDENT 0.0 .TP -.B salt.modules.boto_vpc.nat_gateway_exists(nat_gateway_id=None, subnet_id=None, subnet_name=None, vpc_id=None, vpc_name=None, states=(\(aqpending\(aq, \(aqavailable\(aq), region=None, key=None, keyid=None, profile=None) +.B salt.modules.boto_vpc.nat_gateway_exists(nat_gateway_id=None, subnet_id=None, subnet_name=None, vpc_id=None, vpc_name=None, states=\(aqpending\(aq, \(aqavailable\(aq, region=None, key=None, keyid=None, profile=None) Checks if a nat gateway exists. .sp This function requires boto3 to be installed. @@ -145060,7 +145251,7 @@ Environment variables to set when invoking cabal. Uses the same \fBenv\fP format as the \fBcmd.run\fP execution function .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -150223,6 +150414,9 @@ for obj in objects: .SS salt.modules.cisconso .sp Execution module for Cisco Network Services Orchestrator Proxy minions +.sp +New in version 2016.11.0. + .sp For documentation on setting up the cisconso proxy minion look in the documentation for \fBsalt.proxy.cisconso\fP\&. @@ -150864,7 +151058,7 @@ salt \(aq*\(aq cmd.has_exec cat .UNINDENT .INDENT 0.0 .TP -.B salt.modules.cmdmod.powershell(cmd, cwd=None, stdin=None, runas=None, shell=\(aq/bin/bash\(aq, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, password=None, depth=None, encode_cmd=False, success_retcodes=None, **kwargs) +.B salt.modules.cmdmod.powershell(cmd, cwd=None, stdin=None, runas=None, shell=\(aqpowershell\(aq, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, hide_output=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, password=None, depth=None, encode_cmd=False, success_retcodes=None, **kwargs) Execute the passed PowerShell command and return the output as a dictionary. .sp Other \fBcmd.*\fP functions (besides \fBcmd.powershell_all\fP) @@ -150942,8 +151136,8 @@ New in version 2016.3.0. .IP \(bu 2 -\fBshell\fP (\fI\%str\fP) \-\- Specify an alternate shell. Defaults to the system\(aqs -default shell. +\fBshell\fP (\fI\%str\fP) \-\- Specify an alternate shell. Defaults to "powershell". Can +also use "pwsh" for powershell core if present on the system .IP \(bu 2 \fBpython_shell\fP (\fI\%bool\fP) \-\- If False, let python handle the positional arguments. Set to True to use shell features, such as pipes or @@ -151125,7 +151319,7 @@ salt \(aq*\(aq cmd.powershell "$PSVersionTable.CLRVersion" .UNINDENT .INDENT 0.0 .TP -.B salt.modules.cmdmod.powershell_all(cmd, cwd=None, stdin=None, runas=None, shell=\(aq/bin/bash\(aq, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, quiet=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, password=None, depth=None, encode_cmd=False, force_list=False, success_retcodes=None, **kwargs) +.B salt.modules.cmdmod.powershell_all(cmd, cwd=None, stdin=None, runas=None, shell=\(aqpowershell\(aq, env=None, clean_env=False, template=None, rstrip=True, umask=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, quiet=False, timeout=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, use_vt=False, password=None, depth=None, encode_cmd=False, force_list=False, success_retcodes=None, **kwargs) Execute the passed PowerShell command and return a dictionary with a result field representing the output of the command, as well as other fields showing us what the PowerShell invocation wrote to \fBstderr\fP, the process @@ -151261,8 +151455,8 @@ the target user account must be in the Administrators group. \fBpassword\fP (\fI\%str\fP) \-\- Windows only. Required when specifying \fBrunas\fP\&. This parameter will be ignored on non\-Windows platforms. .IP \(bu 2 -\fBshell\fP (\fI\%str\fP) \-\- Specify an alternate shell. Defaults to the system\(aqs -default shell. +\fBshell\fP (\fI\%str\fP) \-\- Specify an alternate shell. Defaults to "powershell". Can +also use "pwsh" for powershell core if present on the system .IP \(bu 2 \fBpython_shell\fP (\fI\%bool\fP) \-\- If False, let python handle the positional arguments. Set to True to use shell features, such as pipes or @@ -151891,8 +152085,39 @@ New in version 2018.3.0. \fBuse_vt\fP (\fI\%bool\fP) \-\- Use VT utils (saltstack) to stream the command output more interactively to the console and the logs. This is experimental. .IP \(bu 2 -\fBencoded_cmd\fP (\fI\%bool\fP) \-\- Specify if the supplied command is encoded. -Only applies to shell \(aqpowershell\(aq. +\fBencoded_cmd\fP (\fI\%bool\fP) \-\- +.sp +Specify if the supplied command is encoded. +Only applies to shell \(aqpowershell\(aq and \(aqpwsh\(aq. +.sp +New in version 2018.3.0. + +.sp +Older versions of powershell seem to return raw xml data in the return. +To avoid raw xml data in the return, prepend your command with the +following before encoding: +.sp +\fI$ProgressPreference=\(aqSilentlyContinue\(aq; \fP +.sp +The following powershell code block will encode the \fIWrite\-Output\fP +command so that it will not have the raw xml data in the return: +.INDENT 2.0 +.INDENT 3.5 +.sp +.nf +.ft C +# target string +$Command = \(aq$ProgressPreference="SilentlyContinue"; Write\-Output "hello"\(aq + +# Convert to Base64 encoded string +$Encoded = [convert]::ToBase64String([System.Text.encoding]::Unicode.GetBytes($command)) + +Write\-Output $Encoded +.ft P +.fi +.UNINDENT +.UNINDENT + .IP \(bu 2 \fBraise_err\fP (\fI\%bool\fP) \-\- If \fBTrue\fP and the command has a nonzero exit code, a CommandExecutionError exception will be raised. @@ -152214,10 +152439,35 @@ more interactively to the console and the logs. This is experimental. \fBencoded_cmd\fP (\fI\%bool\fP) \-\- .sp Specify if the supplied command is encoded. -Only applies to shell \(aqpowershell\(aq. +Only applies to shell \(aqpowershell\(aq and \(aqpwsh\(aq. .sp New in version 2018.3.0. +.sp +Older versions of powershell seem to return raw xml data in the return. +To avoid raw xml data in the return, prepend your command with the +following before encoding: +.sp +\fI$ProgressPreference=\(aqSilentlyContinue\(aq; \fP +.sp +The following powershell code block will encode the \fIWrite\-Output\fP +command so that it will not have the raw xml data in the return: +.INDENT 2.0 +.INDENT 3.5 +.sp +.nf +.ft C +# target string +$Command = \(aq$ProgressPreference="SilentlyContinue"; Write\-Output "hello"\(aq + +# Convert to Base64 encoded string +$Encoded = [convert]::ToBase64String([System.Text.encoding]::Unicode.GetBytes($command)) + +Write\-Output $Encoded +.ft P +.fi +.UNINDENT +.UNINDENT .IP \(bu 2 \fBredirect_stderr\fP (\fI\%bool\fP) \-\- @@ -152320,6 +152570,9 @@ salt \(aq*\(aq cmd.run_all "grep f" stdin=\(aqone\entwo\enthree\enfour\enfive\en .INDENT 0.0 .TP .B salt.modules.cmdmod.run_bg(cmd, cwd=None, runas=None, group=None, shell=\(aq/bin/bash\(aq, python_shell=None, env=None, clean_env=False, template=None, umask=None, timeout=None, output_encoding=None, output_loglevel=\(aqdebug\(aq, log_callback=None, reset_system_locale=True, ignore_retcode=False, saltenv=\(aqbase\(aq, password=None, prepend_path=None, success_retcodes=None, **kwargs) +New in version 2016.3.0. + +.sp Execute the passed command in the background and return its PID .sp \fBNOTE:\fP @@ -154464,6 +154717,9 @@ salt \(aq*\(aq config.gather_bootstrap_script .INDENT 0.0 .TP .B salt.modules.config.get(key, default=\(aq\(aq, delimiter=\(aq:\(aq, merge=None, omit_opts=False, omit_pillar=False, omit_master=False, omit_grains=False) +New in version 0.14.0. + +.sp Attempt to retrieve the named value from the minion config file, pillar, grains or the master config. If the named value is not available, return the value specified by the \fBdefault\fP argument. If this argument is not @@ -156420,7 +156676,7 @@ Minion side functions for salt\-cp .INDENT 0.0 .TP .B salt.modules.cp.cache_dest(url, saltenv=\(aqbase\(aq) -New in version Neon. +New in version 3000. .sp Returns the expected cache path for the file, if cached using @@ -157585,6 +157841,7 @@ Linux Add an rule to csf allowed hosts See \fB_access_rule()\fP\&. 1\- Add an IP: +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -157646,6 +157903,7 @@ salt \(aq*\(aq csf.allow_ports ports="[22,80,443,4505,4506]" proto=\(aqtcp\(aq d Add an rule to csf denied hosts See \fB_access_rule()\fP\&. 1\- Deny an IP: +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -157663,6 +157921,7 @@ salt \(aq*\(aq csf.deny 127.0.0.1 comment="Too localhosty" .TP .B salt.modules.csf.disable() Disable csf permanently +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -157683,6 +157942,7 @@ salt \(aq*\(aq csf.disable .TP .B salt.modules.csf.enable() Activate csf if not running +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -157705,6 +157965,7 @@ salt \(aq*\(aq csf.enable Returns true a rule for the ip already exists based on the method supplied. Returns false if not found. +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -157752,6 +158013,7 @@ salt \(aq*\(aq csf.allow_port 22 proto=\(aqtcp\(aq direction=\(aqin\(aq .TP .B salt.modules.csf.reload() Restart csf +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -157776,6 +158038,7 @@ salt \(aq*\(aq csf.reload .TP .B salt.modules.csf.running() Check csf status +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -157810,6 +158073,7 @@ salt \(aq*\(aq csf.running Add an rule to the temporary ip allow list. See \fB_access_rule()\fP\&. 1\- Add an IP: +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -157828,6 +158092,7 @@ salt \(aq*\(aq csf.tempallow 127.0.0.1 3600 port=22 direction=\(aqin\(aq comment Add a rule to the temporary ip deny list. See \fB_access_rule()\fP\&. 1\- Add an IP: +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -157846,6 +158111,7 @@ salt \(aq*\(aq csf.tempdeny 127.0.0.1 300 port=22 direction=\(aqin\(aq comment=\ Remove a rule from the csf denied hosts See \fB_access_rule()\fP\&. 1\- Deny an IP: +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -157864,6 +158130,7 @@ salt \(aq*\(aq csf.unallow 127.0.0.1 Remove a rule from the csf denied hosts See \fB_access_rule()\fP\&. 1\- Deny an IP: +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -160318,10 +160585,14 @@ salt \(aq*\(aq disk.blkid token=\(aqTYPE=ext4\(aq Return all contents of dumpe2fs for a specified device .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq disk.dump /dev/sda1 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -160415,10 +160686,14 @@ New in version 2016.3.0. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq disk.hdparms /dev/sda +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -160520,10 +160795,14 @@ salt \(aq*\(aq disk.percent /var Resizes the filesystem. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq disk.resize2fs /dev/sda1 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -162429,7 +162708,7 @@ salt myminion docker.compare_containers foo bar ignore=Hostname .UNINDENT .INDENT 0.0 .TP -.B salt.modules.dockermod.compare_networks(first, second, ignore=\(aqName, Id, Created, Containers\(aq) +.B salt.modules.dockermod.compare_networks(first, second, ignore=\(aqName,Id,Created,Containers\(aq) New in version 2018.3.0. .sp @@ -166897,7 +167176,7 @@ New in version 2016.11.3. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -168645,7 +168924,7 @@ configuration files. New in version 0.17.0: Initial automatic enforcement added when pkg is used on a Gentoo system. .sp -Changed in version 2014.1.0\-Hydrogen: Configure option added to make this behaviour optional, defaulting to +Changed in version 2014.7.0: Configure option added to make this behaviour optional, defaulting to off. .sp @@ -168884,6 +169163,9 @@ Whether or not to sync the portage tree before checking for upgrades. Specifies an integer number of times to backtrack if dependency calculation fails due to a conflict or an unsatisfied dependency (default: \'3\'). +.sp +New in version 2015.8.0. + .UNINDENT .sp CLI Example: @@ -169137,6 +169419,9 @@ force \- forces emerge to install the package from a binhost otherwise it fails Specifies an integer number of times to backtrack if dependency calculation fails due to a conflict or an unsatisfied dependency (default: \'3\'). +.sp +New in version 2015.8.0. + .UNINDENT .sp Returns a dictionary containing the changes: @@ -169353,7 +169638,7 @@ Optional definition such as routing or filter as defined in \fI\%https://www.ela URL of file specifying optional definition such as routing or filter. Cannot be used in combination with \fBbody\fP\&. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169378,7 +169663,7 @@ Single or multiple indices separated by comma, use _all to perform the operation Alias names separated by comma .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169403,7 +169688,7 @@ Single or multiple indices separated by comma, use _all to perform the operation Alias names separated by comma .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169428,7 +169713,7 @@ Single or multiple indices separated by comma, use _all to perform the operation Alias names separated by comma .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169456,7 +169741,7 @@ Return settings in flat format. Whether to return all default clusters setting. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169487,7 +169772,7 @@ Specify the level of detail for returned information, default \(aqcluster\(aq, v Return local information, do not retrieve the state from master node .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169516,7 +169801,7 @@ The settings to be updated. Can be either \(aqtransient\(aq or \(aqpersistent\(a Return settings in flat format. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169542,7 +169827,7 @@ Return Elasticsearch cluster stats. List of cluster nodes (id or name) to display stats for. Use _local for connected node, empty for all .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169576,7 +169861,7 @@ URL of file specifying document to store. Cannot be used in combination with \fB Optional unique document identifier for specified doc_type (empty for random) .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169604,7 +169889,7 @@ Type of the document Document identifier .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169632,7 +169917,7 @@ Document identifier Type of the document, use _all to fetch the first document matching the ID across all types .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169660,7 +169945,7 @@ Document identifier Type of the document, use _all to fetch the first document matching the ID across all types .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169713,7 +169998,7 @@ none \- Wildcard expressions are not accepted. .sp The defaults settings for the above parameters depend on the API being used. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169747,7 +170032,7 @@ Whether to expand wildcard expression to concrete indices that are open, closed Whether specified concrete indices should be ignored when unavailable (missing or closed) .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169775,7 +170060,7 @@ Index definition, such as settings and mappings as defined in \fI\%https://www.e URL to file specifying index definition. Cannot be used in combination with \fBbody\fP\&. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169798,7 +170083,7 @@ Delete an index Index name .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169820,7 +170105,7 @@ Return a boolean indicating whether given index exists Index name .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169842,7 +170127,7 @@ Check for the existence of an index and if it exists, return it Index name .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169893,7 +170178,7 @@ Valid choices are: ‘open’, ‘closed’, ‘none’, ‘all’ .sp The defaults settings for the above parameters depend on the API version being used. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169927,7 +170212,7 @@ Whether to expand wildcard expression to concrete indices that are open, closed Whether specified concrete indices should be ignored when unavailable (missing or closed) .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -169980,14 +170265,16 @@ Valid choices are: ‘open’, ‘closed’, ‘none’, ‘all’ .UNINDENT .sp The defaults settings for the above parameters depend on the API version being used. +.sp +\fBNOTE:\fP .INDENT 7.0 -.TP -.B \&..note:: +.INDENT 3.5 Elasticsearch time units can be found here: \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/common\-options.html#time\-units\fP .UNINDENT +.UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170015,7 +170302,7 @@ Template definition as specified in \fI\%http://www.elastic.co/guide/en/elastics URL to file specifying template definition. Cannot be used in combination with \fBbody\fP\&. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170037,7 +170324,7 @@ Delete an index template (type) along with its data Index template name .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170059,7 +170346,7 @@ Return a boolean indicating whether given index template exists Index template name .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170081,7 +170368,7 @@ Retrieve template definition of index or index/type Index template name .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170101,7 +170388,7 @@ New in version 2017.7.0. .sp Return Elasticsearch information. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170133,7 +170420,7 @@ Mapping definition as specified in \fI\%https://www.elastic.co/guide/en/elastics URL to file specifying mapping definition. Cannot be used in combination with \fBbody\fP\&. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170158,7 +170445,7 @@ Index for the mapping Name of the document type .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170183,7 +170470,7 @@ Index for the mapping Name of the document type .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170211,7 +170498,7 @@ List of cluster nodes (id or name) to display stats for. Use _local for connecte Flatten settings keys .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170236,7 +170523,7 @@ Test connection to Elasticsearch instance. This method does not fail if not expl Throw exception if ping fails .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170265,7 +170552,7 @@ Pipeline id Pipeline definition as specified in \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/master/pipeline.html\fP .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170290,7 +170577,7 @@ Delete Ingest pipeline. Available since Elasticsearch 5.0. Pipeline id .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170315,7 +170602,7 @@ Retrieve Ingest pipeline definition. Available since Elasticsearch 5.0. Pipeline id .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170346,7 +170633,7 @@ Pipeline definition as specified in \fI\%https://www.elastic.co/guide/en/elastic Specify if the output should be more verbose .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170374,7 +170661,7 @@ Repository name Repository definition as in \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/modules\-snapshots.html\fP .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170399,7 +170686,7 @@ Delete existing repository. Repository name .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170427,7 +170714,7 @@ Repository name Retrieve only local information, default is false .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170452,7 +170739,7 @@ Obtain list of cluster nodes which successfully verified this repository. Repository name .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170480,7 +170767,7 @@ Template ID Search template definition .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170505,7 +170792,7 @@ Delete existing search template definition. Template ID .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170530,7 +170817,7 @@ Obtain existing search template definition. Template ID .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170561,7 +170848,7 @@ Snapshot name Snapshot definition as in \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/modules\-snapshots.html\fP .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170589,7 +170876,7 @@ Repository name Snapshot name .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170620,7 +170907,7 @@ Snapshot name, use _all to obtain all snapshots in specified repository Ignore unavailable snapshots .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170651,7 +170938,7 @@ Snapshot name Restore definition as in \fI\%https://www.elastic.co/guide/en/elasticsearch/reference/current/modules\-snapshots.html\fP .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -170682,7 +170969,7 @@ Snapshot name Ignore unavailable snapshots .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -171890,6 +172177,19 @@ New in version 2014.1.0. .sp Test whether the Salt process has the specified access to the file. One of the following modes must be specified: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +f: Test the existence of the path +r: Test the readability of the path +w: Test the writability of the path +x: Test whether the path can be executed +.ft P +.fi +.UNINDENT +.UNINDENT .sp CLI Example: .INDENT 7.0 @@ -172074,14 +172374,14 @@ content will be prepended to the file. If markers are not found, this parameter can be set to a regex which will insert the block before the first found occurrence in the file. .sp -New in version Sodium. +New in version 3001. .TP .B insert_after_match If markers are not found, this parameter can be set to a regex which will insert the block after the first found occurrence in the file. .sp -New in version Sodium. +New in version 3001. .TP .B backup @@ -174883,7 +175183,7 @@ salt \(aq*\(aq file.remove /tmp/foo .UNINDENT .UNINDENT .sp -Changed in version Neon: The method now works on all types of file system entries, not just +Changed in version 3000: The method now works on all types of file system entries, not just files, directories and symlinks. .UNINDENT @@ -178257,17 +178557,23 @@ default=1000 .sp CLI Example: .INDENT 7.0 -.TP -.B salt \(aqsalt\-master.novalocal\(aq gcp.route_create -credential_file=/root/secret_key.json -project_id=cp100\-170315 -name=derby\-db\-route1 -next_hop_instance=instance\-1 -instance_zone=us\-central1\-a -network=default -dest_range=0.0.0.0/0 -tags=[\(aqno\-ip\(aq] -priority=700 +.INDENT 3.5 +.sp +.nf +.ft C +salt \(aqsalt\-master.novalocal\(aq gcp.route_create + credential_file=/root/secret_key.json + project_id=cp100\-170315 + name=derby\-db\-route1 + next_hop_instance=instance\-1 + instance_zone=us\-central1\-a + network=default + dest_range=0.0.0.0/0 + tags=[\(aqno\-ip\(aq] + priority=700 +.ft P +.fi +.UNINDENT .UNINDENT .sp In above example, the instances which are having tag "no\-ip" will route the @@ -178784,8 +179090,13 @@ dependencies for a file; but it does help. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion genesis.ldd_deps bash salt myminion genesis.ldd_deps /bin/bash +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -178798,12 +179109,17 @@ Convert an installation file/script to an SLS file. Currently supports CLI Examples: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt genesis.mksls kickstart /path/to/kickstart.cfg salt genesis.mksls kickstart /path/to/kickstart.cfg /path/to/dest.sls +.ft P +.fi .UNINDENT .UNINDENT .sp -New in version Beryllium. +New in version 2015.8.0. .UNINDENT .INDENT 0.0 @@ -184884,229 +185200,6 @@ salt myminion github.remove_user github\-handle .UNINDENT .UNINDENT .UNINDENT -.SS salt.modules.glance -.sp -Module for handling openstack glance calls. -.INDENT 0.0 -.TP -.B optdepends -.INDENT 7.0 -.IP \(bu 2 -glanceclient Python adapter -.UNINDENT -.TP -.B configuration -This module is not usable until the following are specified -either in a pillar or in the minion\(aqs config file: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -keystone.user: admin -keystone.password: verybadpass -keystone.tenant: admin -keystone.insecure: False #(optional) -keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -If configuration for multiple openstack accounts is required, they can be -set up as different configuration profiles: -For example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -openstack1: - keystone.user: admin - keystone.password: verybadpass - keystone.tenant: admin - keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq - -openstack2: - keystone.user: admin - keystone.password: verybadpass - keystone.tenant: admin - keystone.auth_url: \(aqhttp://127.0.0.2:5000/v2.0/\(aq -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -With this configuration in place, any of the glance functions can -make use of a configuration profile by declaring it explicitly. -For example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -salt \(aq*\(aq glance.image_list profile=openstack1 -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B salt.modules.glance.image_create(name, location=None, profile=None, visibility=None, container_format=\(aqbare\(aq, disk_format=\(aqraw\(aq, protected=None) -Create an image (glance image\-create) -.sp -CLI Example, old format: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -salt \(aq*\(aq glance.image_create name=f16\-jeos \e - disk_format=qcow2 container_format=ovf -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -CLI Example, new format resembling Glance API v2: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -salt \(aq*\(aq glance.image_create name=f16\-jeos visibility=public \e - disk_format=qcow2 container_format=ovf -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -The parameter \(aqvisibility\(aq defaults to \(aqpublic\(aq if not specified. -.UNINDENT -.INDENT 0.0 -.TP -.B salt.modules.glance.image_delete(id=None, name=None, profile=None) -Delete an image (glance image\-delete) -.sp -CLI Examples: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -salt \(aq*\(aq glance.image_delete c2eb2eb0\-53e1\-4a80\-b990\-8ec887eae7df -salt \(aq*\(aq glance.image_delete id=c2eb2eb0\-53e1\-4a80\-b990\-8ec887eae7df -salt \(aq*\(aq glance.image_delete name=f16\-jeos -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B salt.modules.glance.image_list(id=None, profile=None, name=None) -Return a list of available images (glance image\-list) -.sp -CLI Example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -salt \(aq*\(aq glance.image_list -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B salt.modules.glance.image_schema(profile=None) -Returns names and descriptions of the schema "image"\(aqs -properties for this profile\(aqs instance of glance -.sp -CLI Example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -salt \(aq*\(aq glance.image_schema -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B salt.modules.glance.image_show(id=None, name=None, profile=None) -Return details about a specific image (glance image\-show) -.sp -CLI Example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -salt \(aq*\(aq glance.image_show -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B salt.modules.glance.image_update(id=None, name=None, profile=None, **kwargs) -Update properties of given image. -Known to work for: -\- min_ram (in MB) -\- protected (bool) -\- visibility (\(aqpublic\(aq or \(aqprivate\(aq) -.sp -CLI Example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -salt \(aq*\(aq glance.image_update id=c2eb2eb0\-53e1\-4a80\-b990\-8ec887eae7df -salt \(aq*\(aq glance.image_update name=f16\-jeos -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B salt.modules.glance.schema_get(name, profile=None) -.INDENT 7.0 -.TP -.B Known valid names of schemas are: -.INDENT 7.0 -.IP \(bu 2 -image -.IP \(bu 2 -images -.IP \(bu 2 -member -.IP \(bu 2 -members -.UNINDENT -.UNINDENT -.sp -CLI Example: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -salt \(aq*\(aq glance.schema_get name=f16\-jeos -.ft P -.fi -.UNINDENT -.UNINDENT -.UNINDENT .SS salt.modules.glanceng .sp Glance module for interacting with OpenStack Glance @@ -185279,7 +185372,7 @@ salt \(aq*\(aq glanceng.update_image_properties name=0e4febc2a5ab4f2c8f374b05416 .SS salt.modules.glassfish .sp Module for working with the Glassfish/Payara 4.x management API -\&.. versionadded:: Carbon +.. versionadded:: 2016.11.0 :depends: requests .INDENT 0.0 .TP @@ -185580,10 +185673,14 @@ Returns the glusterfs volume\(aqs max op\-version value Requires Glusterfs version > 3.9 .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq glusterfs.get_max_op_version +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -185619,11 +185716,16 @@ New in version 2019.2.0. .sp Returns the version of glusterfs. +.sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq glusterfs.get_version +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -185844,7 +185946,7 @@ Volume name .TP .B force Force the volume start even if the volume is started -\&.. versionadded:: 2015.8.4 +.. versionadded:: 2015.8.4 .UNINDENT .sp CLI Example: @@ -186289,7 +186391,7 @@ salt \(aq*\(aq gpg.decrypt filename=\(aq/path/to/important.file.gpg\(aq use_pass .UNINDENT .INDENT 0.0 .TP -.B salt.modules.gpg.delete_key(keyid=None, fingerprint=None, delete_secret=False, user=None, gnupghome=None) +.B salt.modules.gpg.delete_key(keyid=None, fingerprint=None, delete_secret=False, user=None, gnupghome=None, use_passphrase=True) Get a key from the GPG keychain .INDENT 7.0 .TP @@ -186310,6 +186412,10 @@ Passing the user as \fBsalt\fP will set the GnuPG home directory to the .TP .B gnupghome Specify the location where GPG keyring and related files are stored. +.TP +.B use_passphrase +Whether to use a passphrase with the signing key. Passphrase is received +from Pillar. .UNINDENT .sp CLI Example: @@ -186388,7 +186494,7 @@ salt \(aq*\(aq gpg.encrypt filename=\(aq/path/to/important.file\(aq use_passphra .UNINDENT .INDENT 0.0 .TP -.B salt.modules.gpg.export_key(keyids=None, secret=False, user=None, gnupghome=None) +.B salt.modules.gpg.export_key(keyids=None, secret=False, user=None, gnupghome=None, use_passphrase=False) Export a key from the GPG keychain .INDENT 7.0 .TP @@ -186408,6 +186514,10 @@ Passing the user as \fBsalt\fP will set the GnuPG home directory to the .TP .B gnupghome Specify the location where GPG keyring and related files are stored. +.TP +.B use_passphrase +Whether to use a passphrase with the signing key. Passphrase is received +from Pillar. .UNINDENT .sp CLI Example: @@ -188838,7 +188948,12 @@ Directory to chroot into CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq group.members foo \(aquser1,user2,user3,...\(aq +.ft P +.fi .UNINDENT .UNINDENT .INDENT 7.0 @@ -192221,7 +192336,7 @@ Passes through all the parameters described in the \fI\%utils.http.query function\fP: .INDENT 7.0 .TP -.B salt.utils.http.query(url, method=\(aqGET\(aq, params=None, data=None, data_file=None, header_dict=None, header_list=None, header_file=None, username=None, password=None, auth=None, decode=False, decode_type=\(aqauto\(aq, status=False, headers=False, text=False, cookies=None, cookie_jar=None, cookie_format=\(aqlwp\(aq, persist_session=False, session_cookie_jar=None, data_render=False, data_renderer=None, header_render=False, header_renderer=None, template_dict=None, test=False, test_url=None, node=\(aqminion\(aq, port=80, opts=None, backend=None, ca_bundle=None, verify_ssl=None, cert=None, text_out=None, headers_out=None, decode_out=None, stream=False, streaming_callback=None, header_callback=None, handle=False, agent=\(aqSalt/"3003"\(aq, hide_fields=None, raise_error=True, formdata=False, formdata_fieldname=None, formdata_filename=None, decode_body=True, **kwargs) +.B salt.utils.http.query(url, method=\(aqGET\(aq, params=None, data=None, data_file=None, header_dict=None, header_list=None, header_file=None, username=None, password=None, auth=None, decode=False, decode_type=\(aqauto\(aq, status=False, headers=False, text=False, cookies=None, cookie_jar=None, cookie_format=\(aqlwp\(aq, persist_session=False, session_cookie_jar=None, data_render=False, data_renderer=None, header_render=False, header_renderer=None, template_dict=None, test=False, test_url=None, node=\(aqminion\(aq, port=80, opts=None, backend=None, ca_bundle=None, verify_ssl=None, cert=None, text_out=None, headers_out=None, decode_out=None, stream=False, streaming_callback=None, header_callback=None, handle=False, agent=\(aqSalt/3003+19.gfbc38c2e6d\(aq, hide_fields=None, raise_error=True, formdata=False, formdata_fieldname=None, formdata_filename=None, decode_body=True, **kwargs) Query a resource, and decode the return data .UNINDENT .INDENT 7.0 @@ -195669,7 +195784,7 @@ Remove description snapshots from the system. .sp ::parameter: all. Default: False. Remove all snapshots, if set to True. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -195858,13 +195973,18 @@ Return which packages own each of the services that are currently enabled. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion introspect.enabled_service_owners +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP -.B salt.modules.introspect.running_service_owners(exclude=(\(aq/dev\(aq, \(aq/home\(aq, \(aq/media\(aq, \(aq/proc\(aq, \(aq/run\(aq, \(aq/sys/\(aq, \(aq/tmp\(aq, \(aq/var\(aq)) +.B salt.modules.introspect.running_service_owners(exclude=\(aq/dev\(aq, \(aq/home\(aq, \(aq/media\(aq, \(aq/proc\(aq, \(aq/run\(aq, \(aq/sys/\(aq, \(aq/tmp\(aq, \(aq/var\(aq) Determine which packages own the currently running services. By default, excludes files whose full path starts with \fB/dev\fP, \fB/home\fP, \fB/media\fP, \fB/proc\fP, \fB/run\fP, \fB/sys\fP, \fB/tmp\fP and \fB/var\fP\&. This can be @@ -195873,7 +195993,12 @@ overridden by passing in a new list to \fBexclude\fP\&. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion introspect.running_service_owners +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -195888,8 +196013,13 @@ package dependencies, set \fBrequires\fP to False. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion introspect.service_highstate salt myminion introspect.service_highstate requires=False +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -198229,7 +198359,12 @@ List all of the wireless interfaces CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt minion iwtools.list_interfaces +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -198241,8 +198376,13 @@ List networks on a wireless interface CLI Examples: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt minion iwtools.scan wlp3s0 salt minion iwtools.scan wlp3s0 list +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -198254,7 +198394,12 @@ List networks on a wireless interface CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt minion iwtools.set_mode wlp3s0 Managed +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -199375,7 +199520,12 @@ The name of the user to assign the ticket to. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq jira.assign_issue NET\-123 example_user +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -199661,7 +199811,7 @@ dest : Directory in which to place the source and its contents. .sp force : This function will not copy identical files unless \fIforce\fP is \fITrue\fP .sp -New in version Aluminum. +New in version 3003. .sp CLI Example: @@ -199735,7 +199885,7 @@ This function only works on Juniper native minions .UNINDENT .UNINDENT .sp -New in version Aluminum. +New in version 3003. .sp CLI Example: @@ -199805,7 +199955,7 @@ This function only works on Juniper native minions .UNINDENT .UNINDENT .sp -New in version Aluminum. +New in version 3003. .sp CLI Example: @@ -200285,7 +200435,7 @@ their status (Master, Disabled, Backup). .sp Under the hood parses the result of \fIshow chassis routing\-engine\fP .sp -New in version Aluminum. +New in version 3003. .sp CLI Example: @@ -200364,7 +200514,7 @@ salt \(aqdevice\(aq junos.rpc get\-chassis\-inventory Use the Junos RPC interface to get a list of files and return them as a structure dictionary. .sp -New in version Aluminum. +New in version 3003. .sp CLI Example: @@ -200561,7 +200711,7 @@ New in version 2016.3.0. .sp Create kubernetes namespace from the name, similar to the functionality added to kubectl since v.1.2.0: -\&.. code\-block:: bash +.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 kubectl create namespaces namespace\-name @@ -201784,6 +201934,7 @@ keystone.password: verybadpass keystone.tenant: admin keystone.tenant_id: f80919baedab48ec8931f200c65a50df keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq +keystone.verify_ssl: True .ft P .fi .UNINDENT @@ -201815,6 +201966,7 @@ openstack1: keystone.tenant: admin keystone.tenant_id: f80919baedab48ec8931f200c65a50df keystone.auth_url: \(aqhttp://127.0.0.1:5000/v2.0/\(aq + keystone.verify_ssl: True openstack2: keystone.user: admin @@ -201822,6 +201974,7 @@ openstack2: keystone.tenant: admin keystone.tenant_id: f80919baedab48ec8931f200c65a50df keystone.auth_url: \(aqhttp://127.0.0.2:5000/v2.0/\(aq + keystone.verify_ssl: True .ft P .fi .UNINDENT @@ -203798,7 +203951,7 @@ Linux .INDENT 0.0 .TP .B salt.modules.kubeadm.alpha_certs_renew(rootfs=None) -New in version TBD. +New in version 3001. .sp Renews certificates for a Kubernetes cluster @@ -203823,7 +203976,7 @@ salt \(aq*\(aq kubeadm.alpha_certs_renew .INDENT 0.0 .TP .B salt.modules.kubeadm.alpha_kubeconfig_user(client_name, apiserver_advertise_address=None, apiserver_bind_port=None, cert_dir=None, org=None, token=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Outputs a kubeconfig file for an additional user @@ -203869,7 +204022,7 @@ salt \(aq*\(aq kubeadm.alpha_kubeconfig_user client_name=user .INDENT 0.0 .TP .B salt.modules.kubeadm.alpha_kubelet_config_download(kubeconfig=None, kubelet_version=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Downloads the kubelet configuration from the cluster ConfigMap @@ -203903,7 +204056,7 @@ salt \(aq*\(aq kubeadm.alpha_kubelet_config_download kubelet_version=\(aq1.14.0\ .INDENT 0.0 .TP .B salt.modules.kubeadm.alpha_kubelet_config_enable_dynamic(node_name, kubeconfig=None, kubelet_version=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Enables or updates dynamic kubelet configuration for a node @@ -203939,7 +204092,7 @@ salt \(aq*\(aq kubeadm.alpha_kubelet_config_enable_dynamic node\-1 .INDENT 0.0 .TP .B salt.modules.kubeadm.alpha_selfhosting_pivot(cert_dir=None, config=None, kubeconfig=None, store_certs_in_secrets=False, rootfs=None) -New in version TBD. +New in version 3001. .sp Converts a static Pod\-hosted control plane into a selt\-hosted one @@ -203978,7 +204131,7 @@ salt \(aq*\(aq kubeadm.alpha_selfhost_pivot .INDENT 0.0 .TP .B salt.modules.kubeadm.config_images_list(config=None, feature_gates=None, kubernetes_version=None, kubeconfig=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Print a list of images kubeadm will use @@ -204018,7 +204171,7 @@ salt \(aq*\(aq kubeadm.config_images_list .INDENT 0.0 .TP .B salt.modules.kubeadm.config_images_pull(config=None, cri_socket=None, feature_gates=None, kubernetes_version=None, kubeconfig=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Pull images used by kubeadm @@ -204061,7 +204214,7 @@ salt \(aq*\(aq kubeadm.config_images_pull .INDENT 0.0 .TP .B salt.modules.kubeadm.config_migrate(old_config, new_config=None, kubeconfig=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Read an older version of the kubeadm configuration API types from @@ -204099,7 +204252,7 @@ salt \(aq*\(aq kubeadm.config_migrate /oldconfig.cfg .INDENT 0.0 .TP .B salt.modules.kubeadm.config_print_init_defaults(component_configs=None, kubeconfig=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Return default init configuration, that can be used for \(aqkubeadm @@ -204134,7 +204287,7 @@ salt \(aq*\(aq kubeadm.config_print_init_defaults .INDENT 0.0 .TP .B salt.modules.kubeadm.config_print_join_defaults(component_configs=None, kubeconfig=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Return default join configuration, that can be used for \(aqkubeadm @@ -204169,7 +204322,7 @@ salt \(aq*\(aq kubeadm.config_print_join_defaults .INDENT 0.0 .TP .B salt.modules.kubeadm.config_upload_from_file(config, kubeconfig=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Upload a configuration file to the in\-cluster ConfigMap for @@ -204202,7 +204355,7 @@ salt \(aq*\(aq kubeadm.config_upload_from_file /config.cfg .INDENT 0.0 .TP .B salt.modules.kubeadm.config_upload_from_flags(apiserver_advertise_address=None, apiserver_bind_port=None, apiserver_cert_extra_sans=None, cert_dir=None, cri_socket=None, feature_gates=None, kubernetes_version=None, node_name=None, pod_network_cidr=None, service_cidr=None, service_dns_domain=None, kubeconfig=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Create the in\-cluster configuration file for the first time using @@ -204270,7 +204423,7 @@ salt \(aq*\(aq kubeadm.config_upload_from_flags .INDENT 0.0 .TP .B salt.modules.kubeadm.config_view(kubeconfig=None, rootfs=None) -New in version TBD. +New in version 3001. .sp View the kubeadm configuration stored inside the cluster @@ -204299,7 +204452,7 @@ salt \(aq*\(aq kubeadm.config_view .INDENT 0.0 .TP .B salt.modules.kubeadm.init(apiserver_advertise_address=None, apiserver_bind_port=None, apiserver_cert_extra_sans=None, cert_dir=None, certificate_key=None, config=None, cri_socket=None, experimental_upload_certs=False, feature_gates=None, ignore_preflight_errors=None, image_repository=None, kubernetes_version=None, node_name=None, pod_network_cidr=None, service_cidr=None, service_dns_domain=None, skip_certificate_key_print=False, skip_phases=None, skip_token_print=False, token=None, token_ttl=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Command to set up the Kubernetes control plane @@ -204399,7 +204552,7 @@ salt \(aq*\(aq kubeadm.init pod_network_cidr=\(aq10.244.0.0/16\(aq .INDENT 0.0 .TP .B salt.modules.kubeadm.join(api_server_endpoint=None, apiserver_advertise_address=None, apiserver_bind_port=None, certificate_key=None, config=None, cri_socket=None, discovery_file=None, discovery_token=None, discovery_token_ca_cert_hash=None, discovery_token_unsafe_skip_ca_verification=False, experimental_control_plane=False, ignore_preflight_errors=None, node_name=None, skip_phases=None, tls_bootstrap_token=None, token=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Command to join to an existing cluster @@ -204481,7 +204634,7 @@ salt \(aq*\(aq kubeadm.join 10.160.65.165:6443 token=\(aqtoken\(aq .INDENT 0.0 .TP .B salt.modules.kubeadm.join_params(create_if_needed=False) -New in version TBD. +New in version 3001. .sp Return the parameters required for joining into the cluster @@ -204508,7 +204661,7 @@ salt \(aq*\(aq kubeadm.join_params create_if_needed=True .INDENT 0.0 .TP .B salt.modules.kubeadm.reset(cert_dir=None, cri_socket=None, ignore_preflight_errors=None, kubeconfig=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Revert any changes made to this host by \(aqkubeadm init\(aq or \(aqkubeadm @@ -204548,7 +204701,7 @@ salt \(aq*\(aq kubeadm.join 10.160.65.165:6443 token=\(aqtoken\(aq .INDENT 0.0 .TP .B salt.modules.kubeadm.token_create(token=None, config=None, description=None, groups=None, ttl=None, usages=None, kubeconfig=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Create bootstrap tokens on the server @@ -204604,7 +204757,7 @@ salt \(aq*\(aq kubeadm.token_create usages="[\(aqsigning\(aq]" .INDENT 0.0 .TP .B salt.modules.kubeadm.token_delete(token, kubeconfig=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Delete bootstrap tokens on the server @@ -204639,7 +204792,7 @@ salt \(aq*\(aq kubeadm.token_create a1b2c.0123456789abcdef .INDENT 0.0 .TP .B salt.modules.kubeadm.token_generate(kubeconfig=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Generate and return a bootstrap token, but do not create it on the @@ -204669,7 +204822,7 @@ salt \(aq*\(aq kubeadm.token_generate .INDENT 0.0 .TP .B salt.modules.kubeadm.token_list(kubeconfig=None, rootfs=None) -New in version TBD. +New in version 3001. .sp List bootstrap tokens on the server @@ -204698,7 +204851,7 @@ salt \(aq*\(aq kubeadm.token_list .INDENT 0.0 .TP .B salt.modules.kubeadm.version(kubeconfig=None, rootfs=None) -New in version TBD. +New in version 3001. .sp Return the version of kubeadm @@ -204770,6 +204923,9 @@ salt \(aq*\(aq kubernetes.nodes kubeconfig=/etc/salt/k8s/kubeconfig context=mini .fi .UNINDENT .UNINDENT +.sp +New in version 2017.7.0. + .sp Changed in version 2019.2.0. @@ -204807,7 +204963,7 @@ kubernetes.context .B salt.modules.kubernetesmod.configmaps(namespace=\(aqdefault\(aq, **kwargs) Return a list of kubernetes configmaps defined in the namespace .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -204825,7 +204981,7 @@ salt \(aq*\(aq kubernetes.configmaps namespace=default .B salt.modules.kubernetesmod.create_configmap(name, namespace, data, source=None, template=None, saltenv=\(aqbase\(aq, **kwargs) Creates the kubernetes configmap as defined by the user. .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -204848,11 +205004,18 @@ Creates the kubernetes deployment as defined by the user. .TP .B salt.modules.kubernetesmod.create_namespace(name, **kwargs) Creates a namespace with the specified name. +.sp +CLI Example: .INDENT 7.0 -.TP -.B CLI Example: +.INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq kubernetes.create_namespace salt salt \(aq*\(aq kubernetes.create_namespace name=salt +.ft P +.fi +.UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 @@ -204865,7 +205028,7 @@ Creates the kubernetes deployment as defined by the user. .B salt.modules.kubernetesmod.create_secret(name, namespace=\(aqdefault\(aq, data=None, source=None, template=None, saltenv=\(aqbase\(aq, **kwargs) Creates the kubernetes secret as defined by the user. .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -204889,7 +205052,7 @@ Creates the kubernetes service as defined by the user. .B salt.modules.kubernetesmod.delete_configmap(name, namespace=\(aqdefault\(aq, **kwargs) Deletes the kubernetes configmap defined by name and namespace .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -204907,7 +205070,7 @@ salt \(aq*\(aq kubernetes.delete_configmap name=settings namespace=default .B salt.modules.kubernetesmod.delete_deployment(name, namespace=\(aqdefault\(aq, **kwargs) Deletes the kubernetes deployment defined by name and namespace .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -204925,7 +205088,7 @@ salt \(aq*\(aq kubernetes.delete_deployment name=my\-nginx namespace=default .B salt.modules.kubernetesmod.delete_namespace(name, **kwargs) Deletes the kubernetes namespace defined by name .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -204943,7 +205106,7 @@ salt \(aq*\(aq kubernetes.delete_namespace name=salt .B salt.modules.kubernetesmod.delete_pod(name, namespace=\(aqdefault\(aq, **kwargs) Deletes the kubernetes pod defined by name and namespace .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -204961,7 +205124,7 @@ salt \(aq*\(aq kubernetes.delete_pod name=guestbook\-708336848\-5nl8c namespace= .B salt.modules.kubernetesmod.delete_secret(name, namespace=\(aqdefault\(aq, **kwargs) Deletes the kubernetes secret defined by name and namespace .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -204979,7 +205142,7 @@ salt \(aq*\(aq kubernetes.delete_secret name=confidential namespace=default .B salt.modules.kubernetesmod.delete_service(name, namespace=\(aqdefault\(aq, **kwargs) Deletes the kubernetes service defined by name and namespace .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -204997,7 +205160,7 @@ salt \(aq*\(aq kubernetes.delete_service name=my\-nginx namespace=default .B salt.modules.kubernetesmod.deployments(namespace=\(aqdefault\(aq, **kwargs) Return a list of kubernetes deployments defined in the namespace .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205015,7 +205178,7 @@ salt \(aq*\(aq kubernetes.deployments namespace=default .B salt.modules.kubernetesmod.namespaces(**kwargs) Return the names of the available namespaces .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205033,7 +205196,7 @@ salt \(aq*\(aq kubernetes.namespaces kubeconfig=/etc/salt/k8s/kubeconfig context .B salt.modules.kubernetesmod.node(name, **kwargs) Return the details of the node identified by the specified name .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205052,7 +205215,7 @@ Set the value of the label identified by \fIlabel_name\fP to \fIlabel_value\fP o the node identified by the name \fInode_name\fP\&. Creates the label if not present. .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205069,7 +205232,7 @@ salt \(aq*\(aq kubernetes.node_add_label node_name="minikube" label_ .B salt.modules.kubernetesmod.node_labels(name, **kwargs) Return the labels of the node identified by the specified name .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205087,7 +205250,7 @@ salt \(aq*\(aq kubernetes.node_labels name="minikube" Removes the label identified by \fIlabel_name\fP from the node identified by the name \fInode_name\fP\&. .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205104,7 +205267,7 @@ salt \(aq*\(aq kubernetes.node_remove_label node_name="minikube" lab .B salt.modules.kubernetesmod.nodes(**kwargs) Return the names of the nodes composing the kubernetes cluster .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205122,10 +205285,17 @@ salt \(aq*\(aq kubernetes.nodes kubeconfig=/etc/salt/k8s/kubeconfig context=mini .B salt.modules.kubernetesmod.ping(**kwargs) Checks connections with the kubernetes API server. Returns True if the connection can be established, False otherwise. +.sp +CLI Example: .INDENT 7.0 -.TP -.B CLI Example: +.INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq kubernetes.ping +.ft P +.fi +.UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 @@ -205133,7 +205303,7 @@ salt \(aq*\(aq kubernetes.ping .B salt.modules.kubernetesmod.pods(namespace=\(aqdefault\(aq, **kwargs) Return a list of kubernetes pods defined in the namespace .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205152,7 +205322,7 @@ salt \(aq*\(aq kubernetes.pods namespace=default Replaces an existing configmap with a new one defined by name and namespace with the specified data. .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205178,7 +205348,7 @@ namespace, having the specificed metadata and spec. Replaces an existing secret with a new one defined by name and namespace, having the specificed data. .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205203,7 +205373,7 @@ having the specificed metadata and spec. .B salt.modules.kubernetesmod.secrets(namespace=\(aqdefault\(aq, **kwargs) Return a list of kubernetes secrets defined in the namespace .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205221,7 +205391,7 @@ salt \(aq*\(aq kubernetes.secrets namespace=default .B salt.modules.kubernetesmod.services(namespace=\(aqdefault\(aq, **kwargs) Return a list of kubernetes services defined in the namespace .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205239,7 +205409,7 @@ salt \(aq*\(aq kubernetes.services namespace=default .B salt.modules.kubernetesmod.show_configmap(name, namespace=\(aqdefault\(aq, **kwargs) Return the kubernetes configmap defined by name and namespace. .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205257,7 +205427,7 @@ salt \(aq*\(aq kubernetes.show_configmap name=game\-config namespace=default .B salt.modules.kubernetesmod.show_deployment(name, namespace=\(aqdefault\(aq, **kwargs) Return the kubernetes deployment defined by name and namespace .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205275,7 +205445,7 @@ salt \(aq*\(aq kubernetes.show_deployment name=my\-nginx namespace=default .B salt.modules.kubernetesmod.show_namespace(name, **kwargs) Return information for a given namespace defined by the specified name .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205292,7 +205462,7 @@ salt \(aq*\(aq kubernetes.show_namespace kube\-system .B salt.modules.kubernetesmod.show_pod(name, namespace=\(aqdefault\(aq, **kwargs) Return POD information for a given pod name defined in the namespace .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205312,7 +205482,7 @@ Return the kubernetes secret defined by name and namespace. The secrets can be decoded if specified by the user. Warning: this has security implications. .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205331,7 +205501,7 @@ salt \(aq*\(aq kubernetes.show_secret name=confidential decode=True .B salt.modules.kubernetesmod.show_service(name, namespace=\(aqdefault\(aq, **kwargs) Return the kubernetes service defined by name and namespace .sp -CLI Examples: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205701,7 +205871,7 @@ non\-empty iterable of values. \fBTrue\fP if successful, raises an exception otherwise. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -205757,7 +205927,7 @@ dict mapping each attribute name to an iterable of values. \fBTrue\fP if successful, raises an exception otherwise. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -206009,7 +206179,7 @@ to nest \fBwith\fP statements. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -206046,7 +206216,7 @@ Delete an entry from an LDAP database. \fBTrue\fP if successful, raises an exception otherwise. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -206110,7 +206280,7 @@ with zero or more new values \fBTrue\fP if successful, raises an exception otherwise. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -206182,7 +206352,7 @@ dict that maps each of the matching attribute names to a list of its values. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -208443,7 +208613,7 @@ salt \(aq*\(aq lvm.lvcreate new_snapshot vg_name snapshot=volume_name siz .UNINDENT .UNINDENT .sp -New in version to_complete. +New in version 0.12.0. .sp Support for thin pools and thin volumes @@ -211786,7 +211956,7 @@ salt myminion lxc.restart name .UNINDENT .INDENT 0.0 .TP -.B salt.modules.lxc.retcode(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy, https_proxy, no_proxy\(aq) +.B salt.modules.lxc.retcode(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy,https_proxy,no_proxy\(aq) New in version 2015.5.0. .sp @@ -211874,7 +212044,7 @@ salt myminion lxc.retcode mycontainer \(aqip addr show\(aq .UNINDENT .INDENT 0.0 .TP -.B salt.modules.lxc.run(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy, https_proxy, no_proxy\(aq) +.B salt.modules.lxc.run(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy,https_proxy,no_proxy\(aq) New in version 2015.8.0. .sp @@ -211962,7 +212132,7 @@ salt myminion lxc.run mycontainer \(aqifconfig \-a\(aq .UNINDENT .INDENT 0.0 .TP -.B salt.modules.lxc.run_all(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy, https_proxy, no_proxy\(aq) +.B salt.modules.lxc.run_all(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy,https_proxy,no_proxy\(aq) New in version 2015.5.0. .sp @@ -212057,7 +212227,7 @@ salt myminion lxc.run_all mycontainer \(aqip addr show\(aq .UNINDENT .INDENT 0.0 .TP -.B salt.modules.lxc.run_stderr(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy, https_proxy, no_proxy\(aq) +.B salt.modules.lxc.run_stderr(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy,https_proxy,no_proxy\(aq) New in version 2015.5.0. .sp @@ -212143,7 +212313,7 @@ salt myminion lxc.run_stderr mycontainer \(aqip addr show\(aq .UNINDENT .INDENT 0.0 .TP -.B salt.modules.lxc.run_stdout(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy, https_proxy, no_proxy\(aq) +.B salt.modules.lxc.run_stdout(name, cmd, no_start=False, preserve_state=True, stdin=None, python_shell=True, output_loglevel=\(aqdebug\(aq, use_vt=False, path=None, ignore_retcode=False, chroot_fallback=False, keep_env=\(aqhttp_proxy,https_proxy,no_proxy\(aq) New in version 2015.5.0. .sp @@ -212848,7 +213018,7 @@ CLI Example: .sp .nf .ft C -$ salt \(aq*\(aq lxd.authenticate https://srv01:8443 ~/.config/lxc/client.crt ~/.config/lxc/client.key false +salt \(aq*\(aq lxd.authenticate https://srv01:8443 ~/.config/lxc/client.crt ~/.config/lxc/client.key false .ft P .fi .UNINDENT @@ -214112,7 +214282,7 @@ CLI Examples: .sp .nf .ft C -$ salt \(aq*\(aq lxd.image_alias_add xenial/amd64 x "Short version of xenial/amd64" +salt \(aq*\(aq lxd.image_alias_add xenial/amd64 x "Short version of xenial/amd64" .ft P .fi .UNINDENT @@ -214169,7 +214339,7 @@ CLI Examples: .sp .nf .ft C -$ salt \(aq*\(aq lxd.image_alias_add xenial/amd64 x "Short version of xenial/amd64" +salt \(aq*\(aq lxd.image_alias_add xenial/amd64 x "Short version of xenial/amd64" .ft P .fi .UNINDENT @@ -214267,7 +214437,7 @@ CLI Examples: .sp .nf .ft C -$ salt \(aq*\(aq lxd.image_copy_lxd xenial/amd64 https://srv01:8443 ~/.config/lxc/client.crt ~/.config/lxc/client.key false https://srv02:8443 ~/.config/lxc/client.crt ~/.config/lxc/client.key false aliases="[\(aqxenial/amd64\(aq]" +salt \(aq*\(aq lxd.image_copy_lxd xenial/amd64 https://srv01:8443 ~/.config/lxc/client.crt ~/.config/lxc/client.key false https://srv02:8443 ~/.config/lxc/client.crt ~/.config/lxc/client.key false aliases="[\(aqxenial/amd64\(aq]" .ft P .fi .UNINDENT @@ -214317,11 +214487,14 @@ normally uses self\-signed certificates. .UNINDENT .sp CLI Examples: -.sp -\&..code\-block:: bash .INDENT 7.0 .INDENT 3.5 -$ salt \(aq*\(aq lxd.image_delete xenial/amd64 +.sp +.nf +.ft C +salt \(aq*\(aq lxd.image_delete xenial/amd64 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -214384,11 +214557,14 @@ Return the raw pylxd object or a dict of the image? .UNINDENT .sp CLI Examples: -.sp -\&..code\-block:: bash .INDENT 7.0 .INDENT 3.5 -$ salt \(aq*\(aq lxd.image_from_file salt://lxd/files/busybox.tar.xz aliases=["busybox\-amd64"] +.sp +.nf +.ft C +salt \(aq*\(aq lxd.image_from_file salt://lxd/files/busybox.tar.xz aliases=["busybox\-amd64"] +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -214454,11 +214630,14 @@ Return the raw pylxd object or a dict of the image? .UNINDENT .sp CLI Examples: -.sp -\&..code\-block:: bash .INDENT 7.0 .INDENT 3.5 -$ salt \(aq*\(aq lxd.image_from_simplestreams "\fI\%https://cloud\-images.ubuntu.com/releases\fP" "trusty/amd64" aliases=\(aq["t", "trusty/amd64"]\(aq auto_update=True +.sp +.nf +.ft C +salt \(aq*\(aq lxd.image_from_simplestreams "https://cloud\-images.ubuntu.com/releases" "trusty/amd64" aliases=\(aq["t", "trusty/amd64"]\(aq auto_update=True +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -214521,11 +214700,14 @@ Return the raw pylxd object or a dict of the image? .UNINDENT .sp CLI Examples: -.sp -\&..code\-block:: bash .INDENT 7.0 .INDENT 3.5 -$ salt \(aq*\(aq lxd.image_from_url \fI\%https://dl.stgraber.org/lxd\fP aliases=\(aq["busybox\-amd64"]\(aq +.sp +.nf +.ft C +salt \(aq*\(aq lxd.image_from_url https://dl.stgraber.org/lxd aliases=\(aq["busybox\-amd64"]\(aq +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -214576,11 +214758,14 @@ Return the raw pylxd object or a dict of it? .UNINDENT .sp CLI Examples: -.sp -\&..code\-block:: bash .INDENT 7.0 .INDENT 3.5 -$ salt \(aq*\(aq lxd.image_get +.sp +.nf +.ft C +salt \(aq*\(aq lxd.image_get +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -214631,11 +214816,14 @@ Return the raw pylxd object or a dict of it? .UNINDENT .sp CLI Examples: -.sp -\&..code\-block:: bash .INDENT 7.0 .INDENT 3.5 -$ salt \(aq*\(aq lxd.image_get_by_alias xenial/amd64 +.sp +.nf +.ft C +salt \(aq*\(aq lxd.image_get_by_alias xenial/amd64 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -214692,8 +214880,8 @@ CLI Examples: .sp .nf .ft C -$ salt \(aq*\(aq lxd.image_list true \-\-out=json -$ salt \(aq*\(aq lxd.image_list \-\-out=json +salt \(aq*\(aq lxd.image_list true \-\-out=json +salt \(aq*\(aq lxd.image_list \-\-out=json .ft P .fi .UNINDENT @@ -214828,7 +215016,7 @@ CLI Example: .sp .nf .ft C -$ salt \(aq*\(aq lxd.profile_config_delete autostart boot.autostart.delay +salt \(aq*\(aq lxd.profile_config_delete autostart boot.autostart.delay .ft P .fi .UNINDENT @@ -214885,7 +215073,7 @@ CLI Example: .sp .nf .ft C -$ salt \(aq*\(aq lxd.profile_config_get autostart boot.autostart +salt \(aq*\(aq lxd.profile_config_get autostart boot.autostart .ft P .fi .UNINDENT @@ -214945,7 +215133,7 @@ CLI Example: .sp .nf .ft C -$ salt \(aq*\(aq lxd.profile_config_set autostart boot.autostart 0 +salt \(aq*\(aq lxd.profile_config_set autostart boot.autostart 0 .ft P .fi .UNINDENT @@ -215017,8 +215205,8 @@ CLI Examples: .sp .nf .ft C -$ salt \(aq*\(aq lxd.profile_create autostart config="{boot.autostart: 1, boot.autostart.delay: 2, boot.autostart.priority: 1}" -$ salt \(aq*\(aq lxd.profile_create shared_mounts devices="{shared_mount: {type: \(aqdisk\(aq, source: \(aq/home/shared\(aq, path: \(aq/home/shared\(aq}}" +salt \(aq*\(aq lxd.profile_create autostart config="{boot.autostart: 1, boot.autostart.delay: 2, boot.autostart.priority: 1}" +salt \(aq*\(aq lxd.profile_create shared_mounts devices="{shared_mount: {type: \(aqdisk\(aq, source: \(aq/home/shared\(aq, path: \(aq/home/shared\(aq}}" .ft P .fi .UNINDENT @@ -215074,7 +215262,7 @@ CLI Example: .sp .nf .ft C -$ salt \(aq*\(aq lxd.profile_delete shared_mounts +salt \(aq*\(aq lxd.profile_delete shared_mounts .ft P .fi .UNINDENT @@ -215131,7 +215319,7 @@ CLI Example: .sp .nf .ft C -$ salt \(aq*\(aq lxd.profile_device_delete autostart eth1 +salt \(aq*\(aq lxd.profile_device_delete autostart eth1 .ft P .fi .UNINDENT @@ -215188,7 +215376,7 @@ CLI Example: .sp .nf .ft C -$ salt \(aq*\(aq lxd.profile_device_get default eth0 +salt \(aq*\(aq lxd.profile_device_get default eth0 .ft P .fi .UNINDENT @@ -215245,7 +215433,7 @@ CLI Example: .sp .nf .ft C -$ salt \(aq*\(aq lxd.profile_device_set autostart eth1 nic nictype=bridged parent=lxdbr0 +salt \(aq*\(aq lxd.profile_device_set autostart eth1 nic nictype=bridged parent=lxdbr0 .ft P .fi .UNINDENT @@ -215302,7 +215490,7 @@ CLI Examples: .sp .nf .ft C -$ salt \(aq*\(aq lxd.profile_get autostart +salt \(aq*\(aq lxd.profile_get autostart .ft P .fi .UNINDENT @@ -215485,7 +215673,7 @@ CLI Examples: .sp .nf .ft C -$ salt \(aq*\(aq lxd.snapshots_all test\-container +salt \(aq*\(aq lxd.snapshots_all test\-container .ft P .fi .UNINDENT @@ -215540,7 +215728,7 @@ CLI Examples: .sp .nf .ft C -$ salt \(aq*\(aq lxd.snapshots_create test\-container test\-snapshot +salt \(aq*\(aq lxd.snapshots_create test\-container test\-snapshot .ft P .fi .UNINDENT @@ -215595,7 +215783,7 @@ CLI Examples: .sp .nf .ft C -$ salt \(aq*\(aq lxd.snapshots_delete test\-container test\-snapshot +salt \(aq*\(aq lxd.snapshots_delete test\-container test\-snapshot .ft P .fi .UNINDENT @@ -215650,7 +215838,7 @@ CLI Examples: .sp .nf .ft C -$ salt \(aq*\(aq lxd.snapshots_get test\-container test\-snapshot +salt \(aq*\(aq lxd.snapshots_get test\-container test\-snapshot .ft P .fi .UNINDENT @@ -215932,7 +216120,7 @@ New in version 2016.3.1. The names of the packages for which to return information. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -216617,7 +216805,12 @@ New in version 2016.3.0. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq group.members foo \(aquser1,user2,user3,...\(aq +.ft P +.fi .UNINDENT .UNINDENT .sp @@ -217380,11 +217573,14 @@ A string representing the sleep settings for the computer .UNINDENT .sp CLI Example: -.sp -\&..code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq power.get_computer_sleep +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -217402,11 +217598,14 @@ A string representing the sleep settings for the displey .UNINDENT .sp CLI Example: -.sp -\&..code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq power.get_display_sleep +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -217424,11 +217623,14 @@ A string representing the sleep settings for the hard disk .UNINDENT .sp CLI Example: -.sp -\&..code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq power.get_harddisk_sleep +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -219660,11 +219862,14 @@ True if disable keyboard on lock is on, False if off .UNINDENT .sp CLI Example: -.sp -\&..code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq system.get_disable_keyboard_on_lock +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -222784,7 +222989,7 @@ CLI Example: .sp .nf .ft C -$ salt \(aq*\(aq mandrill.send message="{\(aqsubject\(aq: \(aqHi\(aq, \(aqfrom_email\(aq: \(aqtest@example.com\(aq, \(aqto\(aq: [{\(aqemail\(aq: \(aqrecv@example.com\(aq, \(aqtype\(aq: \(aqto\(aq}]}" +salt \(aq*\(aq mandrill.send message="{\(aqsubject\(aq: \(aqHi\(aq, \(aqfrom_email\(aq: \(aqtest@example.com\(aq, \(aqto\(aq: [{\(aqemail\(aq: \(aqrecv@example.com\(aq, \(aqtype\(aq: \(aqto\(aq}]}" .ft P .fi .UNINDENT @@ -223080,7 +223285,7 @@ Pillar Example: {% set roles = salt[\(aqmatch.filter_by\(aq]({ \(aqweb*\(aq: [\(aqapp\(aq, \(aqcaching\(aq], \(aqdb*\(aq: [\(aqdb\(aq], -}, default=\(aqweb*\(aq) %} +}, minion_id=grains[\(aqid\(aq], default=\(aqweb*\(aq) %} # Make the filtered data available to Pillar: roles: {{ roles | yaml() }} @@ -224310,13 +224515,14 @@ int seconds to wait for the minion to die. If you have a monitor that restarts \fBsalt\-minion\fP when it dies then this is a great way to restart after a minion upgrade. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C ->$ salt minion[12] minion.kill +salt minion[12] minion.kill + minion1: \-\-\-\-\-\-\-\-\-\- killed: @@ -224371,13 +224577,14 @@ if the configuration value \fBminion_restart_command\fP is not set and the process to perform the restart. This behavior is intended for managed salt minion processes. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C ->$ salt minion[12] minion.restart +salt minion[12] minion.restart + minion1: \-\-\-\-\-\-\-\-\-\- comment: @@ -224491,6 +224698,9 @@ salt \(aq*\(aq random.hash \(aqI am a string\(aq md5 .TP .B salt.modules.mod_random.rand_int(start=1, end=10, seed=None) Returns a random integer number between the start and end number. +.sp +New in version 2015.5.3. + .INDENT 7.0 .TP .B start @@ -224525,6 +224735,9 @@ salt \(aq*\(aq random.rand_int 1 10 .B salt.modules.mod_random.seed(range=10, hash=None) Returns a random number within a range. Optional hash argument can be any hashable object. If hash is omitted or None, the id of the minion is used. +.sp +New in version 2015.8.0. + .INDENT 7.0 .TP .B hash: None @@ -225973,7 +226186,9 @@ salt \(aq*\(aq mount.set_fstab /mnt/foo /dev/sdz1 ext4 .INDENT 0.0 .TP .B salt.modules.mount.set_vfstab(name, device, fstype, opts=\(aq\-\(aq, device_fsck=\(aq\-\(aq, pass_fsck=\(aq\-\(aq, mount_at_boot=\(aqyes\(aq, config=\(aq/etc/vfstab\(aq, test=False, match_on=\(aqauto\(aq, not_change=False, **kwargs) -\&..verionadded:: 2016.3.2 +New in version 2016.3.2. + +.sp Verify that this mount is represented in the fstab, change the mount to match the data passed, or add the mount if it is not present. .sp @@ -237302,7 +237517,7 @@ netaddr .B salt.modules.netaddress.cidr_broadcast(cidr) Get the broadcast address associated with a CIDR address. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -237319,7 +237534,7 @@ salt myminion netaddress.cidr_netmask 192.168.0.0/20 .B salt.modules.netaddress.cidr_netmask(cidr) Get the netmask address associated with a CIDR address. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -237336,7 +237551,7 @@ salt myminion netaddress.cidr_netmask 192.168.0.0/20 .B salt.modules.netaddress.list_cidr_ips(cidr) Get a list of IP addresses from a CIDR. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -237353,7 +237568,7 @@ salt myminion netaddress.list_cidr_ips 192.168.0.0/20 .B salt.modules.netaddress.list_cidr_ips_ipv6(cidr) Get a list of IPv6 addresses from a CIDR. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -239308,24 +239523,36 @@ netscaler.pass: password .sp This data can also be passed into pillar. Options passed into opts will overwrite options passed into pillar. -.TP -.B CLI Examples -Calls relying on configuration passed using /etc/salt/minion, grains, or pillars: -\&.. code\-block:: bash -.INDENT 7.0 +.UNINDENT +.sp +CLI Examples: +.INDENT 0.0 .INDENT 3.5 +Calls relying on configuration passed using /etc/salt/minion, grains, or pillars: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C salt\-call netscaler.server_exists server_name +.ft P +.fi .UNINDENT .UNINDENT .sp Calls passing configuration as opts -\&.. code\-block:: bash -.INDENT 7.0 +.INDENT 0.0 .INDENT 3.5 +.sp +.nf +.ft C salt\-call netscaler.server_exists server_name netscaler_host=1.2.3.4 netscaler_user=username netscaler_pass=password salt\-call netscaler.server_exists server_name netscaler_host=1.2.3.5 netscaler_user=username2 netscaler_pass=password2 salt\-call netscaler.server_enable server_name2 netscaler_host=1.2.3.5 salt\-call netscaler.server_up server_name3 netscaler_host=1.2.3.6 netscaler_useSSL=False +.ft P +.fi +.UNINDENT .UNINDENT .UNINDENT .UNINDENT @@ -241851,6 +242078,7 @@ List of extensions .TP .B salt.modules.neutron.list_firewall_rules(profile=None) Fetches a list of all firewall rules for a tenant +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -241875,6 +242103,7 @@ List of firewall rules .TP .B salt.modules.neutron.list_firewalls(profile=None) Fetches a list of all firewalls for a tenant +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -247962,7 +248191,7 @@ salt \(aqregular\-minion\(aq nxos_api.show \(aqshow interfaces\(aq host=sw01.exa .sp Execution module to upgrade Cisco NX\-OS Switches. .sp -New in version xxxx.xx.x. +New in version 3001. .INDENT 0.0 .TP @@ -249289,10 +249518,14 @@ New in version 2016.3.0. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq openvswitch.bridge_create br0 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -249318,10 +249551,14 @@ New in version 2016.3.0. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq openvswitch.bridge_delete br0 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -249339,10 +249576,14 @@ New in version 2016.3.0. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq openvswitch.bridge_exists br0 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -249360,10 +249601,14 @@ New in version 2016.3.0. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq openvswitch.bridge_list +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -249384,10 +249629,14 @@ New in version 2016.3.0. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq openvswitch.interface_get_options tap0 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -249408,10 +249657,14 @@ New in version 2016.3.0. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq openvswitch.interface_get_type tap0 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -249441,10 +249694,14 @@ New in version 2016.3.0. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq openvswitch.port_add br0 8080 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -249474,10 +249731,14 @@ New in version 2016.3.0. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq openvswitch.port_create_gre br0 gre1 5001 192.168.1.10 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -249507,10 +249768,14 @@ New in version 2016.3.0. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq openvswitch.port_create_vlan br0 tap0 100 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -249542,10 +249807,14 @@ New in version 2016.3.0. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq openvswitch.port_create_vxlan br0 vx1 5001 192.168.1.10 8472 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -249566,10 +249835,14 @@ New in version 2016.3.0. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq openvswitch.port_get_tag tap0 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -249590,10 +249863,14 @@ New in version 2016.3.0. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq openvswitch.port_list br0 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -249625,10 +249902,14 @@ New in version 2016.3.0. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq openvswitch.port_remove br0 8080 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -249644,6 +249925,9 @@ minion, and it is using a different module (or gives an error similar to \fI\(aqpkg.install\(aq is not available\fP), see here\&. .UNINDENT .UNINDENT +.sp +New in version 2016.3.0. + .sp \fBNOTE:\fP .INDENT 0.0 @@ -249828,7 +250112,7 @@ replaces, size, source, suggests, url, version .UNINDENT .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -250095,8 +250379,13 @@ then an empty string will be returned for that path. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq pkg.owner /usr/bin/apachectl salt \(aq*\(aq pkg.owner /usr/bin/apachectl /usr/bin/basename +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -252300,8 +252589,13 @@ then an empty string will be returned for that path. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq pkg.owner /usr/bin/apachectl salt \(aq*\(aq pkg.owner /usr/bin/apachectl /usr/bin/zsh +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -252581,8 +252875,13 @@ List escalation policies belonging to this account CLI Example: .INDENT 0.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion pagerduty.list_policies my\-pagerduty\-account salt myminion pagerduty.list_escalation_policies my\-pagerduty\-account +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -252596,7 +252895,12 @@ List incidents belonging to this account CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion pagerduty.list_incidents my\-pagerduty\-account +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -252611,8 +252915,13 @@ List maintenance windows belonging to this account CLI Example: .INDENT 0.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion pagerduty.list_windows my\-pagerduty\-account salt myminion pagerduty.list_maintenance_windows my\-pagerduty\-account +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -252626,8 +252935,13 @@ List escalation policies belonging to this account CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion pagerduty.list_policies my\-pagerduty\-account salt myminion pagerduty.list_escalation_policies my\-pagerduty\-account +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -252639,7 +252953,12 @@ List schedules belonging to this account CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion pagerduty.list_schedules my\-pagerduty\-account +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -252651,7 +252970,12 @@ List services belonging to this account CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion pagerduty.list_services my\-pagerduty\-account +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -252663,7 +252987,12 @@ List users belonging to this account CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion pagerduty.list_users my\-pagerduty\-account +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -252675,8 +253004,13 @@ List maintenance windows belonging to this account CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion pagerduty.list_windows my\-pagerduty\-account salt myminion pagerduty.list_maintenance_windows my\-pagerduty\-account +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -252717,6 +253051,7 @@ The diff function will be invoked as diff(state_information, object_returned_fro should return a dict of data to pass to the PagerDuty update API method, or None if no update is to be performed. If no diff method is provided, the default behavor is to scan the keys in the state_information, comparing the matching values in the object_returned_from_pagerduty, and update any values that differ. +.sp Examples .sp create_or_update_resource("user", ["id","name","email"]) @@ -252728,6 +253063,7 @@ create_or_update_resource("escalation_policies", ["id","name"], diff=my_diff_fun delete any pagerduty resource .sp Helper method for absent() +.sp Example .sp delete_resource("users", key, ["id","name","email"]) # delete by id or name or email @@ -252740,7 +253076,12 @@ List escalation_policies belonging to this account CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion pagerduty.get_escalation_policies +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -252774,7 +253115,12 @@ List schedules belonging to this account CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion pagerduty.get_schedules +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -252786,7 +253132,12 @@ List services belonging to this account CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion pagerduty.get_services +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -252798,7 +253149,12 @@ List users belonging to this account CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion pagerduty.get_users +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -252809,6 +253165,7 @@ Generic resource.absent state method. Pagerduty state modules should be a thin with a custom diff function. .sp This method calls delete_resource() and formats the result as a salt state return value. +.sp Example .sp resource_absent("users", ["id","name","email"]) @@ -252820,6 +253177,7 @@ Generic resource.present state method. Pagerduty state modules should be a thi with a custom diff function. .sp This method calls create_or_update_resource() and formats the result as a salt state return value. +.sp Example .sp resource_present("users", ["id","name","email"]) @@ -257108,7 +257466,7 @@ New in version 2019.2.0. .B salt.modules.pf.disable() Disable the Packet Filter. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -257125,7 +257483,7 @@ salt \(aq*\(aq pf.disable .B salt.modules.pf.enable() Enable the Packet Filter. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -257166,7 +257524,7 @@ Please refer to the OpenBSD \fI\%pfctl(8)\fP documentation for a detailed explanation of each command. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -257191,7 +257549,7 @@ Full path to the file containing the ruleset. Don\(aqt actually load the rules, just parse them. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -257214,7 +257572,7 @@ Log level. Should be one of the following: emerg, alert, crit, err, warning, not info or debug (OpenBSD); or none, urgent, misc, loud (FreeBSD). .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -257245,7 +257603,7 @@ tables .UNINDENT .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -257293,7 +257651,7 @@ Please refer to the OpenBSD \fI\%pfctl(8)\fP documentation for a detailed explanation of each command. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -258391,7 +258749,7 @@ salt \(aq*\(aq pip.install bin_env=/path/to/pip_bin .UNINDENT .UNINDENT .sp -Complicated CLI example: +Complicated CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -258497,11 +258855,11 @@ Directory from which to run pip .TP .B index_url Base URL of Python Package Index -\&.. versionadded:: 2019.2.0 +.. versionadded:: 2019.2.0 .TP .B extra_index_url Additional URL of Python Package Index -\&.. versionadded:: 2019.2.0 +.. versionadded:: 2019.2.0 .UNINDENT .sp CLI Example: @@ -258942,6 +259300,9 @@ minion, and it is using a different module (or gives an error similar to This function is an alias of \fBlatest_version\fP\&. .INDENT 7.0 .INDENT 3.5 +Changed in version 2016.3.0. + +.sp Return the latest version of the named package available for upgrade or installation. .sp @@ -258966,6 +259327,9 @@ salt \(aq*\(aq pkg.latest_version ... .INDENT 0.0 .TP .B salt.modules.pkgin.file_dict(*packages, **kwargs) +Changed in version 2016.3.0. + +.sp List the files that belong to a package. .sp CLI Examples: @@ -259079,6 +259443,9 @@ salt \(aq*\(aq pkg.install .INDENT 0.0 .TP .B salt.modules.pkgin.latest_version(*names, **kwargs) +Changed in version 2016.3.0. + +.sp Return the latest version of the named package available for upgrade or installation. .sp @@ -259101,6 +259468,9 @@ salt \(aq*\(aq pkg.latest_version ... .INDENT 0.0 .TP .B salt.modules.pkgin.list_pkgs(versions_as_list=False, **kwargs) +Changed in version 2016.3.0. + +.sp List the packages currently installed as a dict: .INDENT 7.0 .INDENT 3.5 @@ -262116,6 +262486,7 @@ Gets the current IUSE flags from the tree. .TP .B salt.modules.portage_config.get_missing_flags(conf, atom, flags) Find out which of the given flags are currently not set. +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -262276,7 +262647,12 @@ exist, it will be appended to the end. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt postfix.set_main mailq_path /usr/bin/mailq +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -262303,7 +262679,12 @@ and then returns the full contents of the file. By setting the CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt postfix.set_master smtp inet n y n n 100 smtpd +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -262319,8 +262700,13 @@ modification of the main.cf file; other functions are available for that. CLI Examples: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt postfix.show_main salt postfix.show_main path=/path/to/main.cf +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -262336,8 +262722,13 @@ modification of the main.cf file; other functions are available for that. CLI Examples: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt postfix.show_master salt postfix.show_master path=/path/to/master.cf +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -266254,7 +266645,7 @@ New in version 2019.2.0. .INDENT 0.0 .TP -.B salt.modules.purefb.fs_create(name, size=None, proto=\(aqNFS\(aq, nfs_rules=\(aq*(rw, no_root_squash)\(aq, snapshot=False) +.B salt.modules.purefb.fs_create(name, size=None, proto=\(aqNFS\(aq, nfs_rules=\(aq*(rw,no_root_squash)\(aq, snapshot=False) Create a filesystem on a Pure Storage FlashBlade. .sp Will return False if filesystem already exists. @@ -266816,7 +267207,12 @@ New in version 2015.5.4. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq group.members foo \(aquser1,user2,user3,...\(aq +.ft P +.fi .UNINDENT .UNINDENT .INDENT 7.0 @@ -267190,7 +267586,7 @@ installed automatically by the module. .UNINDENT .UNINDENT .sp -New in version v2014.04. +New in version 2014.4.0. .INDENT 0.0 .TP @@ -269897,6 +270293,9 @@ salt \(aq*\(aq redis.get_key foo .TP .B salt.modules.redismod.get_master_ip(host=None, port=None, password=None) Get host information about slave +.sp +New in version 2016.3.0. + .sp CLI Example: .INDENT 7.0 @@ -270305,6 +270704,9 @@ salt \(aq*\(aq redis.save .TP .B salt.modules.redismod.sentinel_get_master_ip(master, host=None, port=None, password=None) Get ip for sentinel master +.sp +New in version 2016.3.0. + .sp CLI Example: .INDENT 7.0 @@ -270477,6 +270879,7 @@ passing the key on the CLI: Values or Entries are the name/data pairs beneath the keys and subkeys. All keys have a default name/data pair. The name is \fB(Default)\fP with a displayed value of \fB(value not set)\fP\&. The actual value is Null. +.sp Example .sp The following example is an export from the Windows startup portion of the @@ -270730,7 +271133,7 @@ True if successful, otherwise an error is raised .INDENT 7.0 .IP \(bu 2 \fI\%ValueError\fP \-\- If the value of \fBsource\fP is an invalid path or otherwise -causes \fBcp.cache_file\fP to return \fBFalse\fP + causes \fBcp.cache_file\fP to return \fBFalse\fP .IP \(bu 2 \fBCommandExecutionError\fP \-\- If \fBreg.exe\fP exits with a non\-0 exit code .UNINDENT @@ -271370,6 +271773,9 @@ salt \(aq*\(aq service.get_all .TP .B salt.modules.rest_service.list_() Return a list of all available services. +.sp +New in version 2015.8.1. + .sp CLI Example: .INDENT 7.0 @@ -271540,10 +271946,14 @@ New in version 2015.8.3. .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq restartcheck.restartcheck +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -272369,7 +272779,7 @@ not work on binary content. Difference or empty string. For binary files only a notification. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -272465,7 +272875,7 @@ build_host, group, source_rpm, arch, epoch, size, license, signature, packager, .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -272526,7 +272936,7 @@ New in version 2015.5.0. use root as top level directory (default: "/") .UNINDENT .sp -CLI examples: +CLI Examples: .INDENT 7.0 .INDENT 3.5 .sp @@ -273411,7 +273821,12 @@ the service\(aqs name CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq service.show +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -274200,8 +274615,13 @@ Return the metadata for a bucket, or an object in a bucket. CLI Examples: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion s3.head mybucket salt myminion s3.head mybucket myfile.png +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -276687,7 +277107,7 @@ The name of the function to run Any positional arguments to pass to the wheel function. A common example of this would be the \fBmatch\fP arg needed for key functions. .sp -New in version v2015.8.11. +New in version 2015.8.11. .TP .B kwargs @@ -280560,7 +280980,7 @@ salt \(aq*\(aq vmadm.info nacl vnc key=alias .UNINDENT .INDENT 0.0 .TP -.B salt.modules.smartos_vmadm.list_vms(search=None, sort=None, order=\(aquuid, type, ram, state, alias\(aq, keyed=True) +.B salt.modules.smartos_vmadm.list_vms(search=None, sort=None, order=\(aquuid,type,ram,state,alias\(aq, keyed=True) Return a list of VMs .INDENT 7.0 .TP @@ -281761,7 +282181,7 @@ first snapshot ID to compare. Default is last snapshot last snapshot ID to compare. Default is 0 (current state) .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -281823,7 +282243,7 @@ Extra Snapper configuration opts dictionary. It will override the values provide by the given template (if any). .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -281877,7 +282297,7 @@ Set userdata for the snapshot (key\-value pairs). .sp Returns the number of the created snapshot. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -281902,7 +282322,7 @@ Configuration name. (Default: root) List of the snapshots IDs to be deleted. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -281979,7 +282399,7 @@ salt \(aq*\(aq snapper.diff_jid jid=20160607130930720112 .B salt.modules.snapper.get_config(name=\(aqroot\(aq) Retrieves all values from a given configuration .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -281996,7 +282416,7 @@ salt \(aq*\(aq snapper.get_config .B salt.modules.snapper.get_snapshot(number=0, config=\(aqroot\(aq) Get detailed information about a given snapshot .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -282013,7 +282433,7 @@ salt \(aq*\(aq snapper.get_snapshot 1 .B salt.modules.snapper.list_configs() List all available configs .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -282030,7 +282450,7 @@ salt \(aq*\(aq snapper.list_configs .B salt.modules.snapper.list_snapshots(config=\(aqroot\(aq) List available snapshots .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -282064,7 +282484,7 @@ Change the description of the snapshot. (str) Change the userdata dictionary of the snapshot. (dict) .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -282133,7 +282553,7 @@ salt \(aq*\(aq snapper.run file.append args=\(aq["/etc/motd", "some text"]\(aq .B salt.modules.snapper.set_config(name=\(aqroot\(aq, **kwargs) Set configuration values .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -282174,7 +282594,7 @@ first snapshot ID to compare. Default is last snapshot last snapshot ID to compare. Default is 0 (current state) .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -285332,7 +285752,7 @@ Reference: \fI\%https://cwiki.apache.org/confluence/display/solr/Defining+core.p .sp Module for interop with the Splunk API .sp -New in version 2016.3.0.. +New in version 2016.3.0. .INDENT 0.0 .TP @@ -285371,7 +285791,12 @@ create a splunk user by name/email CLI Example: .INDENT 7.0 .INDENT 3.5 -salt myminion splunk.create_user \fI\%user@example.com\fP roles=[\(aquser\(aq] realname="Test User" name=testuser +.sp +.nf +.ft C +salt myminion splunk.create_user user@example.com roles=[\(aquser\(aq] realname="Test User" name=testuser +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -285383,7 +285808,12 @@ Delete a splunk user by email CLI Example: .INDENT 7.0 .INDENT 3.5 -salt myminion splunk_user.delete \fI\%\(aquser@example.com\fP\(aq +.sp +.nf +.ft C +salt myminion splunk_user.delete \(aquser@example.com\(aq +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -285395,8 +285825,13 @@ Get a splunk user by name/email CLI Example: .INDENT 7.0 .INDENT 3.5 -salt myminion splunk.get_user \fI\%\(aquser@example.com\fP\(aq user_details=false -salt myminion splunk.get_user \fI\%\(aquser@example.com\fP\(aq user_details=true +.sp +.nf +.ft C +salt myminion splunk.get_user \(aquser@example.com\(aq user_details=false +salt myminion splunk.get_user \(aquser@example.com\(aq user_details=true +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -285408,7 +285843,12 @@ List all users in the splunk DB CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion splunk.list_users +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -285420,7 +285860,12 @@ Create a splunk user by email CLI Example: .INDENT 7.0 .INDENT 3.5 -salt myminion splunk.update_user \fI\%example@domain.com\fP roles=[\(aquser\(aq] realname="Test User" +.sp +.nf +.ft C +salt myminion splunk.update_user example@domain.com roles=[\(aquser\(aq] realname="Test User" +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -285499,12 +285944,14 @@ splunk_search.get \(aqmy search name\(aq .TP .B salt.modules.splunk_search.list_(profile=\(aqsplunk\(aq) List splunk searches (names only) +.sp +CLI Example: .INDENT 7.0 -.TP -.B CLI Example: +.INDENT 3.5 splunk_search.list .UNINDENT .UNINDENT +.UNINDENT .INDENT 0.0 .TP .B salt.modules.splunk_search.list_all(prefix=None, app=None, owner=None, description_contains=None, name_not_contains=None, profile=\(aqsplunk\(aq) @@ -285523,7 +285970,7 @@ If prefix parameter is given, alarm names in the output will be prepended with the prefix; alarms that have the prefix will be skipped. This can be used to convert existing alarms to be managed by salt, as follows: .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .INDENT 0.0 @@ -285919,7 +286366,7 @@ originally hashed with. This defaults to \fBsha256\fP if not specified. New in version 2016.11.4. .sp -Changed in version 2017.7.0:: default changed from \fBmd5\fP to \fBsha256\fP +Changed in version 2017.7.0: default changed from \fBmd5\fP to \fBsha256\fP .UNINDENT .sp @@ -286084,7 +286531,7 @@ was originally hashed with. This defaults to \fBsha256\fP if not specified. New in version 2016.11.4. .sp -Changed in version 2017.7.0:: default changed from \fBmd5\fP to \fBsha256\fP +Changed in version 2017.7.0: default changed from \fBmd5\fP to \fBsha256\fP .UNINDENT .sp @@ -286146,7 +286593,7 @@ Service support for the REST example .SS salt.modules.ssh_service .sp Provide the service module for the proxy\-minion SSH sample -\&.. versionadded:: 2015.8.2 +.. versionadded:: 2015.8.2 .INDENT 0.0 .TP .B salt.modules.ssh_service.enabled(name, sig=None) @@ -286190,6 +286637,7 @@ salt \(aq*\(aq service.list .TP .B salt.modules.ssh_service.restart(name, sig=None) Restart the specified service with rest_sample +.sp CLI Example: .INDENT 7.0 .INDENT 3.5 @@ -286657,7 +287105,7 @@ salt \(aq*\(aq state.disable bind.config .UNINDENT .INDENT 0.0 .TP -.B salt.modules.state.event(tagmatch=\(aq*\(aq, count=\-1, quiet=False, sock_dir=None, pretty=False, node=\(aqminion\(aq) +.B salt.modules.state.event(tagmatch=\(aq*\(aq, count=\- 1, quiet=False, sock_dir=None, pretty=False, node=\(aqminion\(aq) Watch Salt\(aqs event bus and block until the given tag is matched .sp New in version 2016.3.0. @@ -288076,7 +288524,12 @@ Opts dictionary. Not intended for CLI usage. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq status.proxy_reconnect rest_sample +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -290045,10 +290498,11 @@ If the attribute is a symlink, its destination is returned .B Returns value or bool .UNINDENT +.sp +CLI Example: .INDENT 7.0 -.TP -.B CLI example: -.INDENT 7.0 +.INDENT 3.5 +.INDENT 0.0 .INDENT 3.5 .sp .nf @@ -290060,15 +290514,17 @@ salt \(aq*\(aq sysfs.attr block/sda/queue/logical_block_size .UNINDENT .UNINDENT .UNINDENT +.UNINDENT .INDENT 0.0 .TP .B salt.modules.sysfs.interfaces(root) Generate a dictionary with all available interfaces relative to root. Symlinks are not followed. +.sp +CLI Example: .INDENT 7.0 -.TP -.B CLI example: -.INDENT 7.0 +.INDENT 3.5 +.INDENT 0.0 .INDENT 3.5 .sp .nf @@ -290078,6 +290534,9 @@ salt \(aq*\(aq sysfs.interfaces block/bcache0/bcache .fi .UNINDENT .UNINDENT +.UNINDENT +.UNINDENT +.INDENT 7.0 .TP .B Output example: .INDENT 7.0 @@ -290155,10 +290614,11 @@ Read from SysFS .B Returns the full (tree of) SysFS attributes under key .UNINDENT +.sp +CLI Example: .INDENT 7.0 -.TP -.B CLI example: -.INDENT 7.0 +.INDENT 3.5 +.INDENT 0.0 .INDENT 3.5 .sp .nf @@ -290170,6 +290630,7 @@ salt \(aq*\(aq sysfs.read class/net/em1/statistics .UNINDENT .UNINDENT .UNINDENT +.UNINDENT .INDENT 0.0 .TP .B salt.modules.sysfs.target(key, full=True) @@ -290187,10 +290648,11 @@ Return the basename of a SysFS key path .B Returns fullpath or basename of path .UNINDENT +.sp +CLI Example: .INDENT 7.0 -.TP -.B CLI example: -.INDENT 7.0 +.INDENT 3.5 +.INDENT 0.0 .INDENT 3.5 .sp .nf @@ -290202,14 +290664,16 @@ salt \(aq*\(aq sysfs.read class/ttyS0 .UNINDENT .UNINDENT .UNINDENT +.UNINDENT .INDENT 0.0 .TP .B salt.modules.sysfs.write(key, value) Write a SysFS attribute/action +.sp +CLI Example: .INDENT 7.0 -.TP -.B CLI example: -.INDENT 7.0 +.INDENT 3.5 +.INDENT 0.0 .INDENT 3.5 .sp .nf @@ -290221,6 +290685,7 @@ salt \(aq*\(aq sysfs.write devices/system/cpu/cpu0/cpufreq/scaling_governor \(aq .UNINDENT .UNINDENT .UNINDENT +.UNINDENT .SS salt.modules.syslog_ng .sp Module for getting information about syslog\-ng @@ -290886,6 +291351,19 @@ salt \(aq*\(aq sys.list_functions sys user .UNINDENT .UNINDENT .sp +New in version 0.12.0. + +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +salt \(aq*\(aq sys.list_functions \(aqmodule.specific_function\(aq +.ft P +.fi +.UNINDENT +.UNINDENT +.sp Function names can be specified as globs. .sp New in version 2015.5.0. @@ -290900,19 +291378,6 @@ salt \(aq*\(aq sys.list_functions \(aqsys.list_*\(aq .fi .UNINDENT .UNINDENT -.sp -New in version ?. - -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -salt \(aq*\(aq sys.list_functions \(aqmodule.specific_function\(aq -.ft P -.fi -.UNINDENT -.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -291163,7 +291628,7 @@ salt \(aq*\(aq sys.list_state_functions \(aqfile.s*\(aq .UNINDENT .UNINDENT .sp -New in version ?. +New in version 2016.9. .INDENT 7.0 .INDENT 3.5 @@ -291797,8 +292262,16 @@ Returns True if the system has a hardware clock capable of being set from software. .sp CLI Example: +.INDENT 7.0 +.INDENT 3.5 .sp +.nf +.ft C salt \(aq*\(aq system.has_settable_hwclock +.ft P +.fi +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -292344,14 +292817,19 @@ Enable/disable/mask unit files in the specified root directory CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq service.execs +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP .B salt.modules.systemd_service.firstboot(locale=None, locale_message=None, keymap=None, timezone=None, hostname=None, machine_id=None, root=None) -New in version TBD. +New in version 3001. .sp Call systemd\-firstboot to configure basic settings of the system @@ -292382,7 +292860,12 @@ Operate on an alternative filesystem root CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq service.firstboot keymap=jp locale=en_US.UTF\-8 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -292788,7 +293271,12 @@ Enable/disable/mask unit files in the specified root directory CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq service.show +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -293086,7 +293574,12 @@ Returns (bool success, str message) tuple. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion telemetry.create_alarm rs\-ds033197 {} profile=telemetry +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -293104,7 +293597,12 @@ Returns (bool success, str message) tuple. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion telemetry.delete_alarms rs\-ds033197 profile=telemetry +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -293118,7 +293616,12 @@ Returns dictionary of alarm information CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion telemetry.get_alarms rs\-ds033197 profile=telemetry +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -293133,8 +293636,13 @@ Returns dictionary or list of dictionaries. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion telemetry.get_alert_config rs\-ds033197 currentConnections profile=telemetry salt myminion telemetry.get_alert_config rs\-ds033197 profile=telemetry +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -293156,7 +293664,12 @@ A dict of telemetry config information. CLI Example: .INDENT 7.0 .INDENT 3.5 -salt myminion telemetry.get_notification_channel_id \fI\%userx@company.com\fP profile=telemetry +.sp +.nf +.ft C +salt myminion telemetry.get_notification_channel_id userx@company.com profile=telemetry +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -293170,7 +293683,12 @@ Returns (bool success, str message) tuple. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion telemetry.update_alarm rs\-ds033197 {} profile=telemetry +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -295520,7 +296038,7 @@ salt \(aq*\(aq tls.set_ca_path /etc/certs .INDENT 0.0 .TP .B salt.modules.tls.validate(cert, ca_name, crl_file) -New in version Neon. +New in version 3000. .sp Validate a certificate against a given CA/CRL. @@ -299454,6 +299972,7 @@ all migration functions \fI\%libvirt authentication configuration\fP .UNINDENT .SS Units +.sp Units specification .sp New in version 3002. @@ -300560,7 +301079,7 @@ salt \(aq*\(aq virt.get_loader .UNINDENT .UNINDENT .sp -New in version Fluorine. +New in version 2019.2.0. .UNINDENT .INDENT 0.0 @@ -300898,7 +301417,7 @@ cpu: .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -301055,7 +301574,7 @@ This is specially useful when creating a virtual machine with an installation cd an autoinstallation needing a special first boot configuration. Defaults to \fBFalse\fP .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -301103,7 +301622,7 @@ policy for domain process. The optional \fBmemory\fP element specifies how to al on a NUMA host. \fBmemnode\fP elements can specify memory allocation policies per each guest NUMA node. The definition used in the dictionary can be found at \fI\%cpu parameters definition\fP\&. .sp -New in version Aluminium. +New in version 3003. .INDENT 2.0 .INDENT 3.5 @@ -301124,7 +301643,7 @@ New in version Aluminium. .sp Enable or disable hypervisor\-specific features on the virtual machine. .sp -New in version Aluminium. +New in version 3003. .INDENT 2.0 .INDENT 3.5 @@ -301161,11 +301680,11 @@ This configuration is a dictionary with the properties \fBtrack\fP, \fBtickpolic See \fI\%libvirt time keeping documentation\fP for the possible values. .UNINDENT .sp -New in version Aluminium. +New in version 3003. .sp Set the clock to local time using an offset in seconds -\&.. code\-block:: yaml +.. code\-block:: yaml .INDENT 2.0 .INDENT 3.5 .INDENT 0.0 @@ -301220,7 +301739,7 @@ clock: Dictionary providing details on the serials connection to create. (Default: \fBNone\fP) See \fI\%Serials and Consoles Definitions\fP for more details on the possible values. .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -301229,7 +301748,7 @@ New in version Aluminium. Dictionary providing details on the consoles device to create. (Default: \fBNone\fP) See \fI\%Serials and Consoles Definitions\fP for more details on the possible values. .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -301239,11 +301758,12 @@ List of host devices to passthrough to the guest. The value is a list of device names as provided by the \fI\%node_devices()\fP function. (Default: \fBNone\fP) .sp -New in version Aluminium. +New in version 3003. .UNINDENT .UNINDENT +.sp cpu parameters definition .sp The cpu parameters dictionary can contain the following properties: @@ -301379,6 +301899,7 @@ Optional memorytune element can control allocations for memory bandwidth using t Number of threads for supported disk devices to perform I/O requests. iothread id will be numbered from 1 to the provided number (Default: None). .UNINDENT +.sp Boot parameters definition .sp The boot parameters dictionary can contains the following properties: @@ -301408,9 +301929,10 @@ New in version 3001. .B efi A boolean value. .sp -New in version sodium. +New in version 3001. .UNINDENT +.sp Memory parameter definition .sp Memory parameter can contain the following properties: @@ -301467,6 +301989,7 @@ boolean value to ensure the memory content is discarded just before guest shuts unplugged). Please note that this is just an optimization and is not guaranteed to work in all cases (e.g. when hypervisor crashes). (QEMU/KVM only) .UNINDENT +.sp Network Interfaces Definitions .sp Network interfaces dictionaries can contain the following properties: @@ -301487,6 +302010,7 @@ The desired mac address, computed if \fBNone\fP (Default: \fBNone\fP). .B model The network card model (Default: depends on the hypervisor) .UNINDENT +.sp Disks Definitions .sp Disk dictionaries can contain the following properties: @@ -301599,14 +302123,17 @@ virt: I/O control policy. String value amongst \fBnative\fP, \fBthreads\fP and \fBio_uring\fP\&. (Default: \fBnative\fP) .sp -\&..versionadded:: Aluminium +New in version 3003. + .TP .B iothread_id I/O thread id to assign the disk to. (Default: none assigned) .sp -\&..versionadded:: Aluminium +New in version 3003. + .UNINDENT +.sp Graphics Definition .sp The graphics dictionary can have the following properties: @@ -301632,6 +302159,7 @@ It has a \fBtype\fP property with \fBaddress\fP and \fBNone\fP as possible value By default, not setting the \fBlisten\fP part of the dictionary will default to listen on all addresses. .UNINDENT +.sp Serials and Consoles Definitions .sp Serial dictionaries can contain the following properties: @@ -301667,7 +302195,9 @@ The guest device port number starting from 0 The guest device type. Common values are \fBserial\fP, \fBvirtio\fP or \fBusb\-serial\fP, but more are documented in \fI\%the libvirt documentation\fP\&. .UNINDENT -CLI Example.INDENT 7.0 +.sp +CLI Example +.INDENT 7.0 .INDENT 3.5 .sp .nf @@ -302392,7 +302922,7 @@ Create libvirt network. .sp Forward mode (bridge, router, nat). .sp -Changed in version Aluminium: a \fBNone\fP value creates an isolated network with no forwarding at all +Changed in version 3003: a \fBNone\fP value creates an isolated network with no forwarding at all .IP \(bu 2 @@ -302415,7 +302945,7 @@ The \fBparameters\fP value is a dictionary of virtual port parameters. .UNINDENT .UNINDENT .sp -Changed in version Aluminium: possible dictionary value +Changed in version 3003: possible dictionary value .IP \(bu 2 @@ -302442,7 +302972,7 @@ The \fBnativeMode\fP value can be one of \fBtagged\fP or \fBuntagged\fP\&. .UNINDENT .UNINDENT .sp -Changed in version Aluminium: possible dictionary value +Changed in version 3003: possible dictionary value .IP \(bu 2 @@ -302483,7 +303013,7 @@ New in version 3000. size of the Maximum Transmission Unit (MTU) of the network. (default \fBNone\fP) .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -302505,7 +303035,7 @@ The value is a dictionary with a mandatory \fBname\fP property and an optional \ .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -302533,7 +303063,7 @@ Both values are a dictionary with \fBstart\fP and \fBend\fP values. .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -302553,7 +303083,7 @@ whitespace separated list of network interfaces devices that can be used for thi .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -302573,7 +303103,7 @@ whitespace separated list of addreses of PCI devices that can be used for this n .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -302593,7 +303123,7 @@ device name of the physical interface to use in \fBhostdev\fP forward mode. .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -302633,11 +303163,12 @@ The value is a dictionary described in \fI\%net\-define\-dns\fP\&. .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .UNINDENT .UNINDENT +.sp IP configuration definition .sp Both the IPv4 and IPv6 configuration dictionaries can contain the following properties: @@ -302652,21 +303183,22 @@ A list of dictionaries with \fB\(aqstart\(aq\fP and \fB\(aqend\(aq\fP properties .B hosts A list of dictionaries with \fBip\fP property and optional \fBname\fP, \fBmac\fP and \fBid\fP properties. .sp -New in version Aluminium. +New in version 3003. .TP .B bootp A dictionary with a \fBfile\fP property and an optional \fBserver\fP one. .sp -New in version Aluminium. +New in version 3003. .TP .B tftp The path to the TFTP root directory to serve. .sp -New in version Aluminium. +New in version 3003. .UNINDENT +.sp DNS configuration definition .sp The DNS configuration dictionary contains the following optional properties: @@ -303130,7 +303662,7 @@ The value is a dictionary described in \fI\%net\-define\-dns\fP\&. .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .UNINDENT .INDENT 0.0 @@ -303150,7 +303682,7 @@ List the host available devices. .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .UNINDENT .INDENT 0.0 @@ -303448,6 +303980,7 @@ Note that a transient pool will force \fBstart\fP to \fBTrue\fP\&. (Default: \fB \fBpassword\fP \-\- password to connect with, overriding defaults .UNINDENT .UNINDENT +.sp Permissions definition .sp The permissions are described by a dictionary containing the following keys: @@ -303465,6 +303998,7 @@ the numeric ID of the group. (Default: from the parent folder) .B label the SELinux label. (Default: \fINone\fP) .UNINDENT +.sp CLI Example: .sp Local folder pool: @@ -303936,6 +304470,7 @@ the possible values. \fBpassword\fP \-\- password to connect with, overriding defaults .UNINDENT .UNINDENT +.sp Example: .sp Local folder pool: @@ -304809,7 +305344,7 @@ To update any numatune parameters, specify the new value. To remove any \fBnumat for instance: \(aqnumatune\(aq: \fBNone\fP\&. Please note that \fBNone\fP is mapped to \fBnull\fP in sls file, pass \fBnull\fP in sls file instead. .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -304818,7 +305353,7 @@ New in version Aluminium. Dictionary providing details on the serials connection to create. (Default: \fBNone\fP) See \fI\%Serials and Consoles Definitions\fP for more details on the possible values. .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -304827,7 +305362,7 @@ New in version Aluminium. Dictionary providing details on the consoles device to create. (Default: \fBNone\fP) See \fI\%Serials and Consoles Definitions\fP for more details on the possible values. .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -304838,7 +305373,7 @@ This is specially useful when creating a virtual machine with an installation cd an autoinstallation needing a special first boot configuration. Defaults to \fBFalse\fP .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -304854,7 +305389,7 @@ New in version 3001. .sp Enable or disable hypervisor\-specific features on the virtual machine. .sp -New in version Aluminium. +New in version 3003. .INDENT 2.0 .INDENT 3.5 @@ -304891,11 +305426,11 @@ This configuration is a dictionary with the properties \fBtrack\fP, \fBtickpolic See \fI\%libvirt time keeping documentation\fP for the possible values. .UNINDENT .sp -New in version Aluminium. +New in version 3003. .sp Set the clock to local time using an offset in seconds -\&.. code\-block:: yaml +.. code\-block:: yaml .INDENT 2.0 .INDENT 3.5 .INDENT 0.0 @@ -304951,7 +305486,7 @@ List of host devices to passthrough to the guest. The value is a list of device names as provided by the \fI\%node_devices()\fP function. (Default: \fBNone\fP) .sp -New in version Aluminium. +New in version 3003. .UNINDENT @@ -305397,6 +305932,7 @@ The base volume format will not be guessed for security reasons and is thus mand \fBpassword\fP \-\- password to connect with, overriding defaults .UNINDENT .UNINDENT +.sp CLI Example: .sp Volume on ESX: @@ -305528,7 +306064,9 @@ Create libvirt volume. \fBpassword\fP \-\- password to connect with, overriding defaults .UNINDENT .UNINDENT -CLI Example:.INDENT 7.0 +.sp +CLI Example: +.INDENT 7.0 .INDENT 3.5 .sp .nf @@ -306260,7 +306798,7 @@ salt \(aq*\(aq vsphere.add_capacity_to_diskgroup .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.add_host_to_dvs(host, username, password, vmknic_name, vmnic_name, dvs_name, target_portgroup_name, uplink_portgroup_name, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.add_host_to_dvs(host, username, password, vmknic_name, vmnic_name, dvs_name, target_portgroup_name, uplink_portgroup_name, protocol=None, port=None, host_names=None, verify_ssl=True) Adds an ESXi host to a vSphere Distributed Virtual Switch and migrates the desired adapters to the DVS from the standard switch. .INDENT 7.0 @@ -306301,6 +306839,9 @@ using the default port. Default port is \fB443\fP\&. .TP .B host_names: An array of VMware host names to migrate +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -306546,7 +307087,7 @@ salt \(aq*\(aq vsphere.assign_license license_key=00000:00000 .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.attach_tag(object_id, tag_id, managed_obj=\(aqClusterComputeResource\(aq, server=None, username=None, password=None, service_instance=None) +.B salt.modules.vsphere.attach_tag(object_id, tag_id, managed_obj=\(aqClusterComputeResource\(aq, server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None) Attach an existing tag to an input object. .sp The tag needs to meet the cardinality (\fICategoryModel.cardinality\fP) and @@ -306585,6 +307126,10 @@ for the resources being created and deleted. \fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter center. .IP \(bu 2 \fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter center. +.IP \(bu 2 +\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True +.IP \(bu 2 +\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates. .UNINDENT .TP .B Returns @@ -306907,7 +307452,7 @@ salt \(aq*\(aq vsphere.create_storage_policy policy_name=\(aqpolicy name\(aq .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.create_tag(name, description, category_id, server=None, username=None, password=None, service_instance=None) +.B salt.modules.vsphere.create_tag(name, description, category_id, server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None) Create a tag under a category with given description. .sp CLI Example: @@ -306937,6 +307482,10 @@ salt vm_minion vsphere.create_tag \fBdescription\fP (\fI\%str\fP) \-\- Given description of tag category. .IP \(bu 2 \fBcategory_id\fP (\fI\%str\fP) \-\- Value of category_id representative of the category created previously. +.IP \(bu 2 +\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True +.IP \(bu 2 +\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates. .UNINDENT .TP .B Returns @@ -306966,7 +307515,7 @@ if you do not have the privilege to create tag. .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.create_tag_category(name, description, cardinality, server=None, username=None, password=None, service_instance=None) +.B salt.modules.vsphere.create_tag_category(name, description, cardinality, server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None) Create a category with given cardinality. .sp CLI Example: @@ -306996,6 +307545,10 @@ salt vm_minion vsphere.create_tag_category \fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter center. .IP \(bu 2 \fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter center. +.IP \(bu 2 +\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True +.IP \(bu 2 +\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates. .UNINDENT .TP .B Returns @@ -307224,7 +307777,7 @@ vCenter service instance for connection and configuration .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.delete_tag(tag_id, server=None, username=None, password=None, service_instance=None) +.B salt.modules.vsphere.delete_tag(tag_id, server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None) Delete a tag. .sp CLI Example: @@ -307252,6 +307805,10 @@ The parameter must be an identifier for the resource type: \fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter center. .IP \(bu 2 \fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter center. +.IP \(bu 2 +\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True +.IP \(bu 2 +\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates. .UNINDENT .TP .B Raise @@ -307270,7 +307827,7 @@ if you do not have the privilege to create a category. .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.delete_tag_category(category_id, server=None, username=None, password=None, service_instance=None) +.B salt.modules.vsphere.delete_tag_category(category_id, server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None) Delete a category. .sp CLI Example: @@ -307298,6 +307855,10 @@ The parameter must be an identifier for the resource type: \fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter center. .IP \(bu 2 \fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter center. +.IP \(bu 2 +\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True +.IP \(bu 2 +\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates. .UNINDENT .TP .B Raise @@ -307661,7 +308222,7 @@ salt \(aq*\(aq vsphere.get_host_cache .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.get_host_datetime(host, username, password, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.get_host_datetime(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True) Get the date/time information for a given host or list of host_names. .INDENT 7.0 .TP @@ -307690,6 +308251,9 @@ vCenter the hosts for which to get date/time information. If host_names is not provided, the date/time information will be retrieved for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -307710,7 +308274,7 @@ salt \(aq*\(aq vsphere.get_host_datetime my.vcenter.location root bad\-password .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.get_ntp_config(host, username, password, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.get_ntp_config(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True) Get the NTP configuration information for a given host or list of host_names. .INDENT 7.0 .TP @@ -307739,6 +308303,9 @@ vCenter the hosts for which to get ntp configuration information. If host_names is not provided, the NTP configuration will be retrieved for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -307802,7 +308369,7 @@ See note above .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.get_service_policy(host, username, password, service_name, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.get_service_policy(host, username, password, service_name, protocol=None, port=None, host_names=None, verify_ssl=True) Get the service name\(aqs policy for a given host or list of hosts. .INDENT 7.0 .TP @@ -307865,6 +308432,9 @@ vCenter the hosts for which to get service policy information. If host_names is not provided, the service policy information will be retrieved for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -307885,7 +308455,7 @@ salt \(aq*\(aq vsphere.get_service_policy my.vcenter.location root bad\-password .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.get_service_running(host, username, password, service_name, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.get_service_running(host, username, password, service_name, protocol=None, port=None, host_names=None, verify_ssl=True) Get the service name\(aqs running state for a given host or list of hosts. .INDENT 7.0 .TP @@ -307948,6 +308518,9 @@ vCenter the hosts for which to get the service\(aqs running state. If host_names is not provided, the service\(aqs running state will be retrieved for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -307968,7 +308541,7 @@ salt \(aq*\(aq vsphere.get_service_running my.vcenter.location root bad\-passwor .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.get_ssh_key(host, username, password, protocol=None, port=None, certificate_verify=False) +.B salt.modules.vsphere.get_ssh_key(host, username, password, protocol=None, port=None, certificate_verify=None) Retrieve the authorized_keys entry for root. This function only works for ESXi, not vCenter. .INDENT 7.0 @@ -307987,7 +308560,7 @@ This function only works for ESXi, not vCenter. \fBport\fP \-\- defaults to 443 for https .IP \(bu 2 \fBcertificate_verify\fP \-\- If true require that the SSL connection present -a valid certificate +a valid certificate. Default: True .UNINDENT .TP .B Returns @@ -308132,7 +308705,7 @@ Default is None. .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.get_vmotion_enabled(host, username, password, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.get_vmotion_enabled(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True) Get the VMotion enabled status for a given host or a list of host_names. Returns \fBTrue\fP if VMotion is enabled, \fBFalse\fP if it is not enabled. .INDENT 7.0 @@ -308162,6 +308735,9 @@ tell vCenter which hosts to check if VMotion is enabled. If host_names is not provided, the VMotion status will be retrieved for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -308182,7 +308758,7 @@ salt \(aq*\(aq vsphere.get_vmotion_enabled my.vcenter.location root bad\-passwor .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.get_vsan_eligible_disks(host, username, password, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.get_vsan_eligible_disks(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True) Returns a list of VSAN\-eligible disks for a given host or list of host_names. .INDENT 7.0 .TP @@ -308211,6 +308787,9 @@ tell vCenter which hosts to check if any VSAN\-eligible disks are available. If host_names is not provided, the VSAN\-eligible disks will be retrieved for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -308231,7 +308810,7 @@ salt \(aq*\(aq vsphere.get_vsan_eligible_disks my.vcenter.location root bad\-pas .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.get_vsan_enabled(host, username, password, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.get_vsan_enabled(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True) Get the VSAN enabled status for a given host or a list of host_names. Returns \fBTrue\fP if VSAN is enabled, \fBFalse\fP if it is not enabled, and \fBNone\fP if a VSAN Host Config is unset, per host. @@ -308262,6 +308841,9 @@ tell vCenter which hosts to check if VSAN enabled. If host_names is not provided, the VSAN status will be retrieved for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -308315,7 +308897,7 @@ salt \(aq*\(aq vsphere.list_assigned_licenses .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_attached_tags(object_id, managed_obj=\(aqClusterComputeResource\(aq, server=None, username=None, password=None, service_instance=None) +.B salt.modules.vsphere.list_attached_tags(object_id, managed_obj=\(aqClusterComputeResource\(aq, server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None) List existing tags a user has access to. .sp CLI Example: @@ -308345,6 +308927,10 @@ for the resources being created and deleted. \fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter center. .IP \(bu 2 \fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter center. +.IP \(bu 2 +\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True +.IP \(bu 2 +\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates. .UNINDENT .TP .B Returns @@ -308424,7 +309010,7 @@ salt \(aq*\(aq vsphere.list_cluster .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_clusters(host, username, password, protocol=None, port=None) +.B salt.modules.vsphere.list_clusters(host, username, password, protocol=None, port=None, verify_ssl=True) Returns a list of clusters for the specified host. .INDENT 7.0 .TP @@ -308444,6 +309030,9 @@ protocol. Default protocol is \fBhttps\fP\&. .B port Optionally set to alternate port if the host is not using the default port. Default port is \fB443\fP\&. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -308460,7 +309049,7 @@ salt \(aq*\(aq vsphere.list_clusters 1.2.3.4 root bad\-password .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_datacenters(host, username, password, protocol=None, port=None) +.B salt.modules.vsphere.list_datacenters(host, username, password, protocol=None, port=None, verify_ssl=True) Returns a list of datacenters for the specified host. .INDENT 7.0 .TP @@ -308480,6 +309069,9 @@ protocol. Default protocol is \fBhttps\fP\&. .B port Optionally set to alternate port if the host is not using the default port. Default port is \fB443\fP\&. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -308530,7 +309122,7 @@ salt \(aq*\(aq vsphere.list_datacenters_via_proxy datacenter_names=[dc1, dc2] .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_datastore_clusters(host, username, password, protocol=None, port=None) +.B salt.modules.vsphere.list_datastore_clusters(host, username, password, protocol=None, port=None, verify_ssl=True) Returns a list of datastore clusters for the specified host. .INDENT 7.0 .TP @@ -308550,6 +309142,9 @@ protocol. Default protocol is \fBhttps\fP\&. .B port Optionally set to alternate port if the host is not using the default port. Default port is \fB443\fP\&. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -308566,7 +309161,7 @@ salt \(aq*\(aq vsphere.list_datastore_clusters 1.2.3.4 root bad\-password .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_datastores(host, username, password, protocol=None, port=None) +.B salt.modules.vsphere.list_datastores(host, username, password, protocol=None, port=None, verify_ssl=True) Returns a list of datastores for the specified host. .INDENT 7.0 .TP @@ -308586,6 +309181,9 @@ protocol. Default protocol is \fBhttps\fP\&. .B port Optionally set to alternate port if the host is not using the default port. Default port is \fB443\fP\&. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -308828,7 +309426,7 @@ salt \(aq*\(aq vsphere.list_dvportgroups dvs=dvs1 portgroup_names=[pg1] .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_dvs(host, username, password, protocol=None, port=None) +.B salt.modules.vsphere.list_dvs(host, username, password, protocol=None, port=None, verify_ssl=True) Returns a list of distributed virtual switches for the specified host. .INDENT 7.0 .TP @@ -308848,6 +309446,9 @@ protocol. Default protocol is \fBhttps\fP\&. .B port Optionally set to alternate port if the host is not using the default port. Default port is \fB443\fP\&. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -308892,7 +309493,7 @@ salt \(aq*\(aq vsphere.list_dvss dvs_names=[dvs1,dvs2] .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_folders(host, username, password, protocol=None, port=None) +.B salt.modules.vsphere.list_folders(host, username, password, protocol=None, port=None, verify_ssl=True) Returns a list of folders for the specified host. .INDENT 7.0 .TP @@ -308912,6 +309513,9 @@ protocol. Default protocol is \fBhttps\fP\&. .B port Optionally set to alternate port if the host is not using the default port. Default port is \fB443\fP\&. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -308928,7 +309532,7 @@ salt \(aq*\(aq vsphere.list_folders 1.2.3.4 root bad\-password .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_hosts(host, username, password, protocol=None, port=None) +.B salt.modules.vsphere.list_hosts(host, username, password, protocol=None, port=None, verify_ssl=True) Returns a list of hosts for the specified VMware environment. .INDENT 7.0 .TP @@ -308948,6 +309552,9 @@ protocol. Default protocol is \fBhttps\fP\&. .B port Optionally set to alternate port if the host is not using the default port. Default port is \fB443\fP\&. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -309025,7 +309632,7 @@ salt \(aq*\(aq vsphere.list_licenses .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_networks(host, username, password, protocol=None, port=None) +.B salt.modules.vsphere.list_networks(host, username, password, protocol=None, port=None, verify_ssl=True) Returns a list of networks for the specified host. .INDENT 7.0 .TP @@ -309045,6 +309652,9 @@ protocol. Default protocol is \fBhttps\fP\&. .B port Optionally set to alternate port if the host is not using the default port. Default port is \fB443\fP\&. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -309061,7 +309671,7 @@ salt \(aq*\(aq vsphere.list_networks 1.2.3.4 root bad\-password .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_non_ssds(host, username, password, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.list_non_ssds(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True) Returns a list of Non\-SSD disks for the given host or list of host_names. .sp \fBNOTE:\fP @@ -309100,6 +309710,9 @@ tell vCenter the hosts for which to retrieve Non\-SSD disks. If host_names is not provided, Non\-SSD disks will be retrieved for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -309120,7 +309733,7 @@ salt \(aq*\(aq vsphere.list_non_ssds my.vcenter.location root bad\-password .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_resourcepools(host, username, password, protocol=None, port=None) +.B salt.modules.vsphere.list_resourcepools(host, username, password, protocol=None, port=None, verify_ssl=True) Returns a list of resource pools for the specified host. .INDENT 7.0 .TP @@ -309140,6 +309753,9 @@ protocol. Default protocol is \fBhttps\fP\&. .B port Optionally set to alternate port if the host is not using the default port. Default port is \fB443\fP\&. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -309156,7 +309772,7 @@ salt \(aq*\(aq vsphere.list_resourcepools 1.2.3.4 root bad\-password .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_ssds(host, username, password, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.list_ssds(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True) Returns a list of SSDs for the given host or list of host_names. .INDENT 7.0 .TP @@ -309185,6 +309801,9 @@ tell vCenter the hosts for which to retrieve SSDs. If host_names is not provided, SSDs will be retrieved for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -309232,7 +309851,7 @@ salt \(aq*\(aq vsphere.list_storage_policy policy_names=[policy_name] .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_tag_categories(server=None, username=None, password=None, service_instance=None) +.B salt.modules.vsphere.list_tag_categories(server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None) List existing categories a user has access to. .sp CLI Example: @@ -309256,6 +309875,10 @@ salt vm_minion vsphere.list_tag_categories \fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter center. .IP \(bu 2 \fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter center. +.IP \(bu 2 +\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True +.IP \(bu 2 +\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates. .UNINDENT .TP .B Returns @@ -309267,7 +309890,7 @@ list of str .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_tags(server=None, username=None, password=None, service_instance=None) +.B salt.modules.vsphere.list_tags(server=None, username=None, password=None, service_instance=None, verify_ssl=None, ca_bundle=None) List existing tags a user has access to. .sp CLI Example: @@ -309291,6 +309914,10 @@ salt vm_minion vsphere.list_tags \fBusername\fP (\fIbasestring\fP) \-\- Username associated with the vCenter center. .IP \(bu 2 \fBpassword\fP (\fIbasestring\fP) \-\- Password associated with the vCenter center. +.IP \(bu 2 +\fBverify_ssl\fP (\fIboolean\fP) \-\- Verify the SSL certificate. Default: True +.IP \(bu 2 +\fBca_bundle\fP (\fIbasestring\fP) \-\- Path to the ca bundle to use when verifying SSL certificates. .UNINDENT .TP .B Returns @@ -309326,7 +309953,7 @@ salt \(aq*\(aq vsphere.list_uplink_dvportgroup dvs=dvs_name .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_vapps(host, username, password, protocol=None, port=None) +.B salt.modules.vsphere.list_vapps(host, username, password, protocol=None, port=None, verify_ssl=True) Returns a list of vApps for the specified host. .INDENT 7.0 .TP @@ -309346,6 +309973,9 @@ protocol. Default protocol is \fBhttps\fP\&. .B port Optionally set to alternate port if the host is not using the default port. Default port is \fB443\fP\&. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -309363,7 +309993,7 @@ salt \(aq*\(aq vsphere.list_vapps 1.2.3.4 root bad\-password .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.list_vms(host, username, password, protocol=None, port=None) +.B salt.modules.vsphere.list_vms(host, username, password, protocol=None, port=None, verify_ssl=True) Returns a list of VMs for the specified host. .INDENT 7.0 .TP @@ -309383,6 +310013,9 @@ protocol. Default protocol is \fBhttps\fP\&. .B port Optionally set to alternate port if the host is not using the default port. Default port is \fB443\fP\&. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -309683,7 +310316,7 @@ salt \(aq*\(aq vsphere.reset_syslog_config my.vcenter.location root bad\-passwor .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.service_restart(host, username, password, service_name, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.service_restart(host, username, password, service_name, protocol=None, port=None, host_names=None, verify_ssl=True) Restart the named service for the given host or list of hosts. .INDENT 7.0 .TP @@ -309746,6 +310379,9 @@ vCenter the hosts for which to restart the service. If host_names is not provided, the service will be restarted for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -309766,7 +310402,7 @@ salt \(aq*\(aq vsphere.service_restart my.vcenter.location root bad\-password \( .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.service_start(host, username, password, service_name, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.service_start(host, username, password, service_name, protocol=None, port=None, host_names=None, verify_ssl=True) Start the named service for the given host or list of hosts. .INDENT 7.0 .TP @@ -309829,6 +310465,9 @@ vCenter the hosts for which to start the service. If host_names is not provided, the service will be started for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -309849,7 +310488,7 @@ salt \(aq*\(aq vsphere.service_start my.vcenter.location root bad\-password \(aq .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.service_stop(host, username, password, service_name, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.service_stop(host, username, password, service_name, protocol=None, port=None, host_names=None, verify_ssl=True) Stop the named service for the given host or list of hosts. .INDENT 7.0 .TP @@ -309912,6 +310551,9 @@ vCenter the hosts for which to stop the service. If host_names is not provided, the service will be stopped for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -310015,7 +310657,7 @@ salt \(aq*\(aq vsphere.set_coredump_network_config my.vcenter.location root bad\ .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.set_ntp_config(host, username, password, ntp_servers, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.set_ntp_config(host, username, password, ntp_servers, protocol=None, port=None, host_names=None, verify_ssl=True) Set NTP configuration for a given host of list of host_names. .INDENT 7.0 .TP @@ -310048,6 +310690,9 @@ vCenter which hosts to configure ntp servers. If host_names is not provided, the NTP servers will be configured for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -310068,7 +310713,7 @@ salt \(aq*\(aq vsphere.ntp_configure my.vcenter.location root bad\-password \(aq .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.set_service_policy(host, username, password, service_name, service_policy, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.set_service_policy(host, username, password, service_name, service_policy, protocol=None, port=None, host_names=None, verify_ssl=True) Set the service name\(aqs policy for a given host or list of hosts. .INDENT 7.0 .TP @@ -310134,6 +310779,9 @@ vCenter the hosts for which to set the service policy. If host_names is not provided, the service policy information will be retrieved for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -310282,7 +310930,7 @@ salt \(aq*\(aq vsphere.syslog_service_reload my.vcenter.location root bad\-passw .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.system_info(host, username, password, protocol=None, port=None) +.B salt.modules.vsphere.system_info(host, username, password, protocol=None, port=None, verify_ssl=True) Return system information about a VMware environment. .INDENT 7.0 .TP @@ -310302,6 +310950,9 @@ protocol. Default protocol is \fBhttps\fP\&. .B port Optionally set to alternate port if the host is not using the default port. Default port is \fB443\fP\&. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -310469,7 +311120,7 @@ salt \(aq*\(aq vsphere.update_dvs dvs_dict=$dvs_dict dvs=dvs1 .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.update_host_datetime(host, username, password, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.update_host_datetime(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True) Update the date/time on the given host or list of host_names. This function should be used with caution since network delays and execution delays can result in time skews. .INDENT 7.0 @@ -310499,6 +311150,9 @@ tell vCenter which hosts should update their date/time. If host_names is not provided, the date/time will be updated for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -310519,7 +311173,7 @@ salt \(aq*\(aq vsphere.update_date_time my.vcenter.location root bad\-password .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.update_host_password(host, username, password, new_password, protocol=None, port=None) +.B salt.modules.vsphere.update_host_password(host, username, password, new_password, protocol=None, port=None, verify_ssl=True) Update the password for a given host. .sp \fBNOTE:\fP @@ -310549,6 +311203,9 @@ protocol. Default protocol is \fBhttps\fP\&. .B port Optionally set to alternate port if the host is not using the default port. Default port is \fB443\fP\&. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -310646,7 +311303,7 @@ vCenter service instance for connection and configuration .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.upload_ssh_key(host, username, password, ssh_key=None, ssh_key_file=None, protocol=None, port=None, certificate_verify=False) +.B salt.modules.vsphere.upload_ssh_key(host, username, password, ssh_key=None, ssh_key_file=None, protocol=None, port=None, certificate_verify=None) Upload an ssh key for root to an ESXi host via http PUT. This function only works for ESXi, not vCenter. Only one ssh key can be uploaded for root. Uploading a second key will @@ -310672,7 +311329,7 @@ ssh_key_file, but not both. \fBport\fP \-\- defaults to 443 for https .IP \(bu 2 \fBcertificate_verify\fP \-\- If true require that the SSL connection present -a valid certificate +a valid certificate. Default: True .UNINDENT .TP .B Returns @@ -310695,7 +311352,7 @@ salt \(aq*\(aq vsphere.upload_ssh_key my.esxi.host root bad\-password ssh_key_fi .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.vmotion_disable(host, username, password, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.vmotion_disable(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True) Disable vMotion for a given host or list of host_names. .INDENT 7.0 .TP @@ -310724,6 +311381,9 @@ tell vCenter which hosts should disable VMotion. If host_names is not provided, VMotion will be disabled for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -310744,7 +311404,7 @@ salt \(aq*\(aq vsphere.vmotion_disable my.vcenter.location root bad\-password .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.vmotion_enable(host, username, password, protocol=None, port=None, host_names=None, device=\(aqvmk0\(aq) +.B salt.modules.vsphere.vmotion_enable(host, username, password, protocol=None, port=None, host_names=None, device=\(aqvmk0\(aq, verify_ssl=True) Enable vMotion for a given host or list of host_names. .INDENT 7.0 .TP @@ -310777,6 +311437,9 @@ information is used for a single ESXi host. .B device The device that uniquely identifies the VirtualNic that will be used for VMotion for each host. Defaults to \fBvmk0\fP\&. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -310797,7 +311460,7 @@ salt \(aq*\(aq vsphere.vmotion_enable my.vcenter.location root bad\-password .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.vsan_add_disks(host, username, password, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.vsan_add_disks(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True) Add any VSAN\-eligible disks to the VSAN System for the given host or list of host_names. .INDENT 7.0 .TP @@ -310827,6 +311490,9 @@ VSAN system. If host_names is not provided, VSAN\-eligible disks will be added to the hosts\(aqs VSAN system for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -310847,7 +311513,7 @@ salt \(aq*\(aq vsphere.vsan_add_disks my.vcenter.location root bad\-password .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.vsan_disable(host, username, password, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.vsan_disable(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True) Disable VSAN for a given host or list of host_names. .INDENT 7.0 .TP @@ -310876,6 +311542,9 @@ tell vCenter which hosts should disable VSAN. If host_names is not provided, VSAN will be disabled for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -310896,7 +311565,7 @@ salt \(aq*\(aq vsphere.vsan_disable my.vcenter.location root bad\-password .UNINDENT .INDENT 0.0 .TP -.B salt.modules.vsphere.vsan_enable(host, username, password, protocol=None, port=None, host_names=None) +.B salt.modules.vsphere.vsan_enable(host, username, password, protocol=None, port=None, host_names=None, verify_ssl=True) Enable VSAN for a given host or list of host_names. .INDENT 7.0 .TP @@ -310925,6 +311594,9 @@ tell vCenter which hosts should enable VSAN. If host_names is not provided, VSAN will be enabled for the \fBhost\fP location instead. This is useful for when service instance connection information is used for a single ESXi host. +.TP +.B verify_ssl +Verify the SSL certificate. Default: True .UNINDENT .sp CLI Example: @@ -311821,7 +312493,7 @@ targeted. Default is None. .IP \(bu 2 \fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10 .IP \(bu 2 -and later. Server editions of Windows use ServerManager instead. +\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- .UNINDENT .TP .B Returns @@ -311962,7 +312634,7 @@ targeted. Default is None. .IP \(bu 2 \fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10 .IP \(bu 2 -and later. Server editions of Windows use ServerManager instead. +\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- .UNINDENT .TP .B Returns @@ -312030,7 +312702,7 @@ targeted. Default is None. .IP \(bu 2 \fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10 .IP \(bu 2 -and later. Server editions of Windows use ServerManager instead. +\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- .UNINDENT .TP .B Returns @@ -312064,7 +312736,7 @@ List features on the system or in a package \fBpackage\fP (\fIOptional\fP\fI[\fP\fI\%str\fP\fI]\fP) \-\- .sp The full path to the package. Can be either a -\&.cab file or a folder. Should point to the original source of the +.cab file or a folder. Should point to the original source of the package, not to where the file is installed. You cannot use this command to get package information for .msu files .sp @@ -312123,7 +312795,7 @@ targeted. Default is None. .IP \(bu 2 \fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10 .IP \(bu 2 -and later. Server editions of Windows use ServerManager instead. +\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- .UNINDENT .TP .B Returns @@ -312266,7 +312938,7 @@ targeted. Default is None. .IP \(bu 2 \fI\%NotImplementedError\fP \-\- For all versions of Windows that are not Windows 10 .IP \(bu 2 -and later. Server editions of Windows use ServerManager instead. +\fBand later. Server editions of Windows use ServerManager instead.\fP \-\- .UNINDENT .TP .B Returns @@ -313184,7 +313856,7 @@ this function is superfluous and will generate an info level log entry if used directly. .sp If you do actually want to set the \(aqprimary group\(aq of a file, use \fBfile -\&.chpgrp\fP\&. +.chpgrp\fP\&. .sp To set group permissions use \fBfile.set_perms\fP .INDENT 7.0 @@ -320940,7 +321612,7 @@ salt \-t 600 \(aq*\(aq win_servermanager.remove Telnet\-Client .sp Windows Service module. .sp -Changed in version 2016.11.0: \- Rewritten to use PyWin32 +Changed in version 2016.11.0: Rewritten to use PyWin32 .INDENT 0.0 .TP @@ -324631,7 +325303,7 @@ salt \(aqminion\-id\(aq system.unjoin_domain username=\(aqunjoinuser\(aq \e .SS salt.modules.win_task .sp Windows Task Scheduler Module -\&.. versionadded:: 2016.3.0 +.. versionadded:: 2016.3.0 .sp A module for working with the Windows Task Scheduler. You can add and edit existing tasks. @@ -325527,7 +326199,7 @@ str: A string with the error message if there is an error .IP \(bu 2 \fBArgumentValueError\fP \-\- If arguments are invalid .IP \(bu 2 -\fBCommandExecutionError\fP +\fBCommandExecutionError\fP \-\- .UNINDENT .UNINDENT .sp @@ -329513,9 +330185,9 @@ compatibility in mind. Useful documentation: .sp \&. \fI\%http://downloads.xen.org/Wiki/XenAPI/xenapi\-1.0.6.pdf\fP -\&. \fI\%http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/api/\fP -\&. \fI\%https://github.com/xapi\-project/xen\-api/tree/master/scripts/examples/python\fP -\&. \fI\%http://xenbits.xen.org/gitweb/?p=xen.git;a=tree;f=tools/python/xen/xm;hb=HEAD\fP +. \fI\%http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/api/\fP +. \fI\%https://github.com/xapi\-project/xen\-api/tree/master/scripts/examples/python\fP +. \fI\%http://xenbits.xen.org/gitweb/?p=xen.git;a=tree;f=tools/python/xen/xm;hb=HEAD\fP .INDENT 0.0 .TP .B salt.modules.xapi_virt.freecpu() @@ -329656,7 +330328,7 @@ salt \(aq*\(aq virt.list_domains .UNINDENT .INDENT 0.0 .TP -.B salt.modules.xapi_virt.migrate(vm_, target, live=1, port=0, node=\-1, ssl=None, change_home_server=0) +.B salt.modules.xapi_virt.migrate(vm_, target, live=1, port=0, node=\- 1, ssl=None, change_home_server=0) Migrates the virtual machine to another hypervisor .sp CLI Example: @@ -330922,7 +331594,7 @@ not work on binary content. Difference string or raises and exception if examined file is binary. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -330951,7 +331623,7 @@ was installed from the Fedora / EPEL repositories. .UNINDENT .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -331271,7 +331943,7 @@ Return the information of the named package(s), installed on the system. \fBall_versions\fP \-\- Include information for all versions of the packages installed on the minion. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -331582,7 +332254,7 @@ New in version 2017.7.0. .sp List prefetched packages downloaded by Yum in the local disk. .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -332258,6 +332930,29 @@ salt \(aq*\(aq pkg.remove pkgs=\(aq["foo", "bar"]\(aq .UNINDENT .INDENT 0.0 .TP +.B salt.modules.yumpkg.services_need_restart(**kwargs) +New in version 3003. + +.sp +List services that use files which have been changed by the +package manager. It might be needed to restart them. +.sp +Requires systemd. +.sp +CLI Examples: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +salt \(aq*\(aq pkg.services_need_restart +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP .B salt.modules.yumpkg.unhold(name=None, pkgs=None, sources=None, **kwargs) New in version 2014.7.0. @@ -332697,10 +333392,14 @@ On success string with Zabbix API version, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.apiinfo_version +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -332886,10 +333585,14 @@ IDs of the deleted hosts. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.host_delete 10106 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -332927,10 +333630,14 @@ IDs of the deleted hosts, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.host_exists \(aqZabbix server\(aq +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -332972,10 +333679,14 @@ Array with convenient hosts details, False if no host found or on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.host_get \(aqZabbix server\(aq +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333006,10 +333717,14 @@ Array with host interfaces details, False if no convenient host interfaces found .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.host_inventory_get 101054 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333043,10 +333758,14 @@ ID of the updated host, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.host_inventory_set 101054 asset_tag=jml3322 type=vm clear_old=True +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333074,10 +333793,14 @@ Array with details about hosts, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.host_list +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333121,10 +333844,14 @@ ID of the updated host. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.host_update 10084 name=\(aqZabbix server2\(aq +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333162,10 +333889,14 @@ ID of the created host group. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.hostgroup_create MyNewGroup +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333195,10 +333926,14 @@ ID of the deleted host groups, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.hostgroup_delete 23 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333234,10 +333969,14 @@ True if at least one host group exists, False if not or on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.hostgroup_exists MyNewGroup +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333283,10 +334022,14 @@ Array with host groups details, False if no convenient host group found or on fa .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.hostgroup_get MyNewGroup +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333314,10 +334057,14 @@ Array with details about host groups, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.hostgroup_list +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333357,10 +334104,14 @@ IDs of updated host groups. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.hostgroup_update 24 name=\(aqRenamed Name\(aq +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333415,10 +334166,14 @@ ID of the created host interface, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.hostinterface_create 10105 192.193.194.197 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333448,10 +334203,14 @@ ID of deleted host interfaces, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.hostinterface_delete 50 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333490,10 +334249,14 @@ Array with host interfaces details, False if no convenient host interfaces found .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.hostinterface_get 101054 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333531,10 +334294,14 @@ ID of the updated host interface, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.hostinterface_update 6 ip_=0.0.0.2 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333619,10 +334386,14 @@ ID of deleted mediatype, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.mediatype_delete 3 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333656,11 +334427,15 @@ Array with mediatype details, False if no mediatype found or on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.mediatype_get name=\(aqEmail\(aq salt \(aq*\(aq zabbix.mediatype_get mediatypeids="[\(aq1\(aq, \(aq2\(aq, \(aq3\(aq]" +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333695,10 +334470,14 @@ IDs of the updated mediatypes, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.usergroup_update 8 name="Email update" +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333732,10 +334511,14 @@ Response from Zabbix API .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.run_query proxy.create \(aq{"host": "zabbixproxy.domain.com", "status": "5"}\(aq +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333801,11 +334584,15 @@ Array with convenient template details, False if no template found or on failure .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.template_get name=\(aqTemplate OS Linux\(aq salt \(aq*\(aq zabbix.template_get templateids="[\(aq10050\(aq, \(aq10001\(aq]" +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333845,11 +334632,15 @@ IDs of the created media. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 -salt \(aq*\(aq zabbix.user_addmedia 4 active=0 mediatypeid=1 period=\(aq1\-7,00:00\-24:00\(aq \fI\%sendto=\(aqsupport2@example.com\fP\(aq +.sp +.nf +.ft C +salt \(aq*\(aq zabbix.user_addmedia 4 active=0 mediatypeid=1 period=\(aq1\-7,00:00\-24:00\(aq sendto=\(aqsupport2@example.com\(aq severity=63 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333894,10 +334685,14 @@ On success string with id of the created user. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.user_create james password007 \(aq[7, 12]\(aq firstname=\(aqJames Bond\(aq +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333927,10 +334722,14 @@ On success array with userids of deleted users. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.user_delete 15 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333960,10 +334759,14 @@ IDs of the deleted media, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.user_deletemedia 27 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -333993,10 +334796,14 @@ True if user exists, else False. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.user_exists james +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -334028,10 +334835,14 @@ Array with details of convenient users, False on failure of if no user found. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.user_get james +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -334069,10 +334880,14 @@ List of retrieved media, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.user_getmedia +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -334100,10 +334915,14 @@ Array with user details. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.user_list +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -334141,10 +334960,14 @@ Id of the updated user on success. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.user_update 16 visible_name=\(aqJames Brown\(aq +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -334182,10 +335005,14 @@ IDs of the created user groups. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.usergroup_create GroupName +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -334213,10 +335040,14 @@ IDs of the deleted user groups. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.usergroup_delete 28 +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -334250,10 +335081,14 @@ True if at least one user group that matches the given filter criteria exists, e .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.usergroup_exists Guests +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -334295,10 +335130,14 @@ Array with convenient user groups details, False if no user group found or on fa .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.usergroup_get Guests +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -334326,10 +335165,14 @@ Array with enabled user groups details, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.usergroup_list +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -334367,10 +335210,14 @@ IDs of the updated user group, False on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.usergroup_update 8 name=guestsRenamed +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -334543,10 +335390,14 @@ Array with usermacro details, False if no usermacro found or on failure. .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zabbix.usermacro_get macro=\(aq{$SNMP_COMMUNITY}\(aq +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -334873,9 +335724,6 @@ New in version 2016.3.0. .INDENT 0.0 .TP -.B depends -requests -.TP .B configuration This module requires a \(aqzenoss\(aq entry in the master/minion config. .sp @@ -334889,6 +335737,8 @@ zenoss: hostname: https://zenoss.example.com username: admin password: admin123 + verify_ssl: True + ca_bundle: /etc/ssl/certs/ca\-certificates.crt .ft P .fi .UNINDENT @@ -334912,10 +335762,17 @@ A function to connect to a zenoss server and add a new device entry. \fBprod_state\fP \-\- (Optional) The prodState to set on the device. If none, defaults to 1000 ( production ) .UNINDENT .UNINDENT +.sp +CLI Example: .INDENT 7.0 -.TP -.B CLI Example: +.INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zenoss.add_device +.ft P +.fi +.UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 @@ -334927,10 +335784,17 @@ Check to see if a device already exists in Zenoss. .B Parameters \fBdevice\fP \-\- (Optional) Will use the grain \(aqfqdn\(aq by default .UNINDENT +.sp +CLI Example: .INDENT 7.0 -.TP -.B CLI Example: +.INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zenoss.device_exists +.ft P +.fi +.UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 @@ -334942,10 +335806,17 @@ Find a device in Zenoss. If device not found, returns None. .B Parameters \fBdevice\fP \-\- (Optional) Will use the grain \(aqfqdn\(aq by default .UNINDENT +.sp +CLI Example: .INDENT 7.0 -.TP -.B CLI Example: +.INDENT 3.5 +.sp +.nf +.ft C salt \(aq*\(aq zenoss.find_device +.ft P +.fi +.UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 @@ -334962,10 +335833,17 @@ A function to set the prod_state in zenoss. \fBdevice\fP \-\- (Optional) Will use the grain \(aqfqdn\(aq by default. .UNINDENT .UNINDENT +.sp +CLI Example: .INDENT 7.0 -.TP -.B CLI Example: +.INDENT 3.5 +.sp +.nf +.ft C salt zenoss.set_prod_state 1000 hostname +.ft P +.fi +.UNINDENT .UNINDENT .UNINDENT .SS salt.modules.zfs @@ -335317,7 +336195,7 @@ local, default, inherited, temporary, and none. The default value is all sources .B parsable boolean display numbers in parsable (exact) values (default = True) -\&.. versionadded:: 2018.3.0 +.. versionadded:: 2018.3.0 .UNINDENT .sp \fBNOTE:\fP @@ -335512,7 +336390,7 @@ sort order (default = ascending) .B parsable boolean display numbers in parsable (exact) values -\&.. versionadded:: 2018.3.0 +.. versionadded:: 2018.3.0 .UNINDENT .sp New in version 2015.5.0. @@ -337141,7 +338019,7 @@ salt minion1 zookeeper.create /test/name daniel profile=prod .UNINDENT .INDENT 0.0 .TP -.B salt.modules.zookeeper.delete(path, version=\-1, recursive=False, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None) +.B salt.modules.zookeeper.delete(path, version=\- 1, recursive=False, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None) Delete znode .INDENT 7.0 .TP @@ -337437,7 +338315,7 @@ salt minion1 zookeeper.make_digest_acl username=daniel password=mypass allperms= .UNINDENT .INDENT 0.0 .TP -.B salt.modules.zookeeper.set(path, value, version=\-1, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None) +.B salt.modules.zookeeper.set(path, value, version=\- 1, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None) Update znode with new value .INDENT 7.0 .TP @@ -337483,7 +338361,7 @@ salt minion1 zookeeper.set /test/name gtmanfred profile=prod .UNINDENT .INDENT 0.0 .TP -.B salt.modules.zookeeper.set_acls(path, acls, version=\-1, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None) +.B salt.modules.zookeeper.set_acls(path, acls, version=\- 1, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None) Set acls on a znode .INDENT 7.0 .TP @@ -338183,7 +339061,7 @@ salt \(aq*\(aq zpool.labelclear /path/to/dev .UNINDENT .INDENT 0.0 .TP -.B salt.modules.zpool.list_(properties=\(aqsize, alloc, free, cap, frag, health\(aq, zpool=None, parsable=True) +.B salt.modules.zpool.list_(properties=\(aqsize,alloc,free,cap,frag,health\(aq, zpool=None, parsable=True) New in version 2015.5.0. .sp @@ -338701,7 +339579,7 @@ New in version 2017.7.0. .sp Converts string wildcard to a zypper query. -\&.. rubric:: Example +.. rubric:: Example .sp \(aq1.2.3.4*\(aq is \(aq1.2.3.4.whatever.is.here\(aq and is equal to: \(aq1.2.3.4 >= and < 1.2.3.5\(aq @@ -338720,7 +339598,10 @@ Query range .UNINDENT .INDENT 0.0 .TP -.B salt.modules.zypperpkg.add_lock(packages, root=None, **kwargs) +.B salt.modules.zypperpkg.add_lock(name, root=None, **kwargs) +Deprecated since version 3003: This function is deprecated. Please use \fBhold()\fP instead. + +.sp Add a package lock. Specify packages to lock by exact name. .INDENT 7.0 .TP @@ -338736,7 +339617,6 @@ CLI Example: .ft C salt \(aq*\(aq pkg.add_lock salt \(aq*\(aq pkg.add_lock ,, -salt \(aq*\(aq pkg.add_lock pkgs=\(aq["foo", "bar"]\(aq .ft P .fi .UNINDENT @@ -338804,7 +339684,7 @@ The root parameter can also be passed via the keyword argument. Difference string or raises and exception if examined file is binary. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -338831,7 +339711,7 @@ executed. operate on a different root directory. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -338914,6 +339794,38 @@ salt \(aq*\(aq pkg.get_repo alias .UNINDENT .INDENT 0.0 .TP +.B salt.modules.zypperpkg.hold(name=None, pkgs=None, **kwargs) +New in version 3003. + +.sp +Add a package hold. Specify one of \fBname\fP and \fBpkgs\fP\&. +.INDENT 7.0 +.TP +.B name +A package name to hold, or a comma\-separated list of package names to +hold. +.TP +.B pkgs +A list of packages to hold. The \fBname\fP parameter will be ignored if +this option is passed. +.UNINDENT +.sp +CLI Example: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +salt \(aq*\(aq pkg.hold +salt \(aq*\(aq pkg.hold ,, +salt \(aq*\(aq pkg.hold pkgs=\(aq["foo", "bar"]\(aq +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP .B salt.modules.zypperpkg.info_available(*names, **kwargs) Return the information of the named package available for the system. .INDENT 7.0 @@ -338927,7 +339839,7 @@ executed or not. operate on a different root directory. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -338981,7 +339893,7 @@ ignore, report .UNINDENT .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -339194,7 +340106,7 @@ executed or not. operate on a different root directory. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -339220,7 +340132,7 @@ List prefetched packages downloaded by Zypper in the local disk. operate on a different root directory. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -339959,10 +340871,16 @@ salt \(aq*\(aq pkg.remove pkgs=\(aq["foo", "bar"]\(aq .UNINDENT .INDENT 0.0 .TP -.B salt.modules.zypperpkg.remove_lock(packages, root=None, **kwargs) +.B salt.modules.zypperpkg.remove_lock(name, root=None, **kwargs) +Deprecated since version 3003: This function is deprecated. Please use \fBunhold()\fP instead. + +.sp Remove specified package lock. .INDENT 7.0 .TP +.B name +A package name, or a comma\-separated list of package names. +.TP .B root operate on a different root directory. .UNINDENT @@ -339975,7 +340893,6 @@ CLI Example: .ft C salt \(aq*\(aq pkg.remove_lock salt \(aq*\(aq pkg.remove_lock ,, -salt \(aq*\(aq pkg.remove_lock pkgs=\(aq["foo", "bar"]\(aq .ft P .fi .UNINDENT @@ -340092,6 +341009,64 @@ salt \(aq*\(aq pkg.search .UNINDENT .INDENT 0.0 .TP +.B salt.modules.zypperpkg.services_need_restart(root=None, **kwargs) +New in version 3003. + +.sp +List services that use files which have been changed by the +package manager. It might be needed to restart them. +.INDENT 7.0 +.TP +.B root +operate on a different root directory. +.UNINDENT +.sp +CLI Examples: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +salt \(aq*\(aq pkg.services_need_restart +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B salt.modules.zypperpkg.unhold(name=None, pkgs=None, **kwargs) +New in version 3003. + +.sp +Remove a package hold. +.INDENT 7.0 +.TP +.B name +A package name to unhold, or a comma\-separated list of package names to +unhold. +.TP +.B pkgs +A list of packages to unhold. The \fBname\fP parameter will be ignored if +this option is passed. +.UNINDENT +.sp +CLI Example: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +salt \(aq*\(aq pkg.unhold +salt \(aq*\(aq pkg.unhold ,, +salt \(aq*\(aq pkg.unhold pkgs=\(aq["foo", "bar"]\(aq +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP .B salt.modules.zypperpkg.upgrade(refresh=True, dryrun=False, dist_upgrade=False, fromrepo=None, novendorchange=False, skip_verify=False, no_recommends=False, root=None, **kwargs) Changed in version 2015.8.12,2016.3.3,2016.11.0: On minions running systemd>=205, \fI\%systemd\-run(1)\fP is now used to isolate commands which modify installed packages from the @@ -341141,15 +342116,100 @@ Content\-Type: application/json .UNINDENT .INDENT 7.0 .TP -.B POST -Mock out specified imports. +.B POST(**kwargs) +Send one or more Salt commands in the request body +.INDENT 7.0 +.TP +.B POST / +.INDENT 7.0 +.TP +.B Request Headers +.INDENT 7.0 +.IP \(bu 2 +\fBX\-Auth\-Token\fP \-\- a session token from \fI\%Login\fP\&. +.IP \(bu 2 +\fBAccept\fP \-\- the desired response format. +.IP \(bu 2 +\fBContent\-Type\fP \-\- the format of the request body. +.UNINDENT +.TP +.B Response Headers +.INDENT 7.0 +.IP \(bu 2 +\fBContent\-Type\fP \-\- the format of the response body; depends on the +\fIAccept\fP request header. +.UNINDENT +.TP +.B Status Codes +.INDENT 7.0 +.IP \(bu 2 +\fB200\fP \-\- success +.IP \(bu 2 +\fB400\fP \-\- bad or malformed request +.IP \(bu 2 +\fB401\fP \-\- authentication required +.IP \(bu 2 +\fB406\fP \-\- requested Content\-Type not available +.UNINDENT +.UNINDENT .sp -This allows autodoc to do its thing without having oodles of req\(aqd -installed libs. This doesn\(aqt work with \fBimport *\fP imports. +lowstate data describing Salt commands must be sent in the +request body. +.UNINDENT .sp -This Mock class can be configured to return a specific values at specific names, if required. +\fBExample request:\fP +.INDENT 7.0 +.INDENT 3.5 .sp -\fI\%https://read\-the\-docs.readthedocs.io/en/latest/faq.html#i\-get\-import\-errors\-on\-libraries\-that\-depend\-on\-c\-modules\fP +.nf +.ft C +curl \-sSik https://localhost:8000 \e + \-b ~/cookies.txt \e + \-H "Accept: application/x\-yaml" \e + \-H "Content\-type: application/json" \e + \-d \(aq[{"client": "local", "tgt": "*", "fun": "test.ping"}]\(aq +.ft P +.fi +.UNINDENT +.UNINDENT +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +POST / HTTP/1.1 +Host: localhost:8000 +Accept: application/x\-yaml +X\-Auth\-Token: d40d1e1e +Content\-Type: application/json + +[{"client": "local", "tgt": "*", "fun": "test.ping"}] +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBExample response:\fP +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +HTTP/1.1 200 OK +Content\-Length: 200 +Allow: GET, HEAD, POST +Content\-Type: application/x\-yaml + +return: +\- ms\-0: true + ms\-1: true + ms\-2: true + ms\-3: true + ms\-4: true +.ft P +.fi +.UNINDENT +.UNINDENT .UNINDENT .UNINDENT .SS \fB/login\fP @@ -346613,12 +347673,14 @@ The optional \fBtag_list_key\fP indicates which keys should be added to \fBec2_tags_list\fP and be split by \fBtag_list_sep\fP (by default \fB;\fP). If a tag key is included in \fBtag_list_key\fP it is removed from ec2_tags. If a tag does not exist it is still included as an empty list. +.sp +\fBNOTE:\fP .INDENT 0.0 -.TP -.B \&..note:: +.INDENT 3.5 As with any master configuration change, restart the salt\-master daemon for changes to take effect. .UNINDENT +.UNINDENT .INDENT 0.0 .INDENT 3.5 .sp @@ -348113,7 +349175,7 @@ $ cat /path/to/stack/config.cfg core.yml osarchs/%{ __grains__[\(aqosarch\(aq] }}.yml oscodenames/%{ __grains__[\(aqoscodename\(aq] }.yml -% for role in pillar\&.get(\(aqroles\(aq, []): +% for role in pillar.get(\(aqroles\(aq, []): roles/%{ role }.yml % endfor minions/%{ minion_id }.yml @@ -350657,12 +351719,12 @@ For example, you could have a PillarStack config file which looks like: $ cat /path/to/stack/config.cfg core.yml common/*.yml -osarchs/{{ __grains__[\(aqosarch\(aq] }}\&.yml -oscodenames/{{ __grains__[\(aqoscodename\(aq] }}\&.yml +osarchs/{{ __grains__[\(aqosarch\(aq] }}.yml +oscodenames/{{ __grains__[\(aqoscodename\(aq] }}.yml {%\- for role in pillar.get(\(aqroles\(aq, []) %} -roles/{{ role }}\&.yml +roles/{{ role }}.yml {%\- endfor %} -minions/{{ minion_id }}\&.yml +minions/{{ minion_id }}.yml .ft P .fi .UNINDENT @@ -352163,6 +353225,7 @@ proxy: host: username: password: + verify_ssl: True .ft P .fi .UNINDENT @@ -352613,6 +353676,9 @@ shutdown is a no\-op. .SS salt.proxy.docker .sp Docker Proxy Minion +.sp +New in version 2019.2.0. + .INDENT 0.0 .TP .B depends @@ -352684,6 +353750,7 @@ This is the a dummy proxy\-minion designed for testing the proxy minion subsyste .INDENT 0.0 .TP .B salt.proxy.dummy.fns() +Method called by grains module. .UNINDENT .INDENT 0.0 .TP @@ -352698,6 +353765,8 @@ Refresh the grains .INDENT 0.0 .TP .B salt.proxy.dummy.init(opts) +Required. +Can be used to initialize the server connection. .UNINDENT .INDENT 0.0 .TP @@ -354858,6 +355927,9 @@ Closes connection with the device. .SS salt.proxy.nxos .sp Proxy Minion for Cisco NX\-OS Switches +.sp +New in version 2016.11.0. + .sp The Cisco NX\-OS Proxy Minion is supported on NX\-OS devices for the following connection types: 1) Connection Type SSH @@ -355336,6 +356408,7 @@ proxy: host: username: password: + verify_ssl: True .ft P .fi .UNINDENT @@ -356027,6 +357100,7 @@ an api over HTTP and doesn\(aqt have the python stack to run a minion. .INDENT 0.0 .TP .B salt.proxy.ssh_sample.fns() +Method called by grains module. .UNINDENT .INDENT 0.0 .TP @@ -356062,9 +357136,14 @@ Install a "package" on the ssh server List "packages" by executing a command via ssh This function is called in response to the salt command .INDENT 7.0 -.TP -.B \&..code\-block::bash +.INDENT 3.5 +.sp +.nf +.ft C salt target_minion pkg.list_pkgs +.ft P +.fi +.UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 @@ -357389,7 +358468,7 @@ _ .SS salt.runners.asam .SS Novell ASAM Runner .sp -New in version Beryllium. +New in version 2015.8.0. .sp Runner to interact with Novell ASAM Fan\-Out Driver @@ -357410,9 +358489,11 @@ asam: prov1.domain.com username: "testuser" password: "verybadpass" + verify_ssl: true prov2.domain.com username: "testuser" password: "verybadpass" + verify_ssl: true .ft P .fi .UNINDENT @@ -358255,7 +359336,7 @@ salt\-run config.get file_roots,base delimiter=\(aq,\(aq .SS salt.runners.ddns .SS Dynamic DNS Runner .sp -New in version Beryllium. +New in version 2015.8.0. .sp Runner to interact with DNS server and create/delete/update DNS records @@ -362915,7 +363996,7 @@ master config file. .UNINDENT .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -364289,7 +365370,7 @@ A wrapper around the \fBSSHClient.cmd\fP method. Execute orchestration functions .INDENT 0.0 .TP -.B salt.runners.state.event(tagmatch=\(aq*\(aq, count=\-1, quiet=False, sock_dir=None, pretty=False, node=\(aqmaster\(aq) +.B salt.runners.state.event(tagmatch=\(aq*\(aq, count=\- 1, quiet=False, sock_dir=None, pretty=False, node=\(aqmaster\(aq) Watch Salt\(aqs event bus and block until the given tag is matched .sp New in version 2014.7.0. @@ -364321,7 +365402,7 @@ this glob or regular expression. for shell tools); pretty\-print the JSON output if \fBTrue\fP\&. .IP \(bu 2 \fBnode\fP \-\- Watch the minion\-side or master\-side event bus. -\&.. versionadded:: 2016.3.0 +.. versionadded:: 2016.3.0 .UNINDENT .UNINDENT .sp @@ -364401,7 +365482,7 @@ Changed in version 2014.1.1: Runner renamed from \fBstate.sls\fP to \fBstate.orc Changed in version 2014.7.0: Runner uses the pillar variable .sp -Changed in version develop: Runner uses the pillar_enc variable that allows renderers to render the pillar. +Changed in version 2017.5: Runner uses the pillar_enc variable that allows renderers to render the pillar. This is usable when supplying the contents of a file as pillar, and the file contains gpg\-encrypted entries. @@ -364468,10 +365549,14 @@ The state.show_sls module function .UNINDENT .sp CLI Example: -\&.. code\-block:: bash .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt\-run state.orch_show_sls my\-orch\-formula.my\-orch\-state \(aqpillar={ nodegroup: ng1 }\(aq +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -365473,7 +366558,12 @@ Read pillar data from Confidant via its API. CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt myminion sdb.get \(aqsdb://confidant/credentials\(aq +.ft P +.fi .UNINDENT .UNINDENT .sp @@ -367446,12 +368536,6 @@ Github User State Module T} _ T{ -\fBglance\fP -T} T{ -Managing Images in OpenStack Glance -T} -_ -T{ \fBglance_image\fP T} T{ Management of OpenStack Glance Images @@ -368956,6 +370040,9 @@ _ .TE .SS salt.states.acme .SS ACME / Let\(aqs Encrypt certificate management state +.sp +New in version 2016.3. + .sp See also the module documentation .INDENT 0.0 @@ -370269,7 +371356,7 @@ group_id: Group ID packaging: Packaging .IP \(bu 2 classifier: Classifier -\&.. versionadded:: 2015.8.0 +.. versionadded:: 2015.8.0 .IP \(bu 2 .INDENT 2.0 .TP @@ -370281,10 +371368,10 @@ One of the following: .UNINDENT .IP \(bu 2 username: Artifactory username -\&.. versionadded:: 2015.8.0 +.. versionadded:: 2015.8.0 .IP \(bu 2 password: Artifactory password -\&.. versionadded:: 2015.8.0 +.. versionadded:: 2015.8.0 .UNINDENT .TP .B target_dir @@ -370479,12 +371566,12 @@ Make a tag for the job. .B user string The user to run the at job -\&.. versionadded:: 2014.1.4 +.. versionadded:: 2014.1.4 .TP .B unique_tag boolean If set to True job will not be added if a job with the tag exists. -\&.. versionadded:: 2017.7.0 +.. versionadded:: 2017.7.0 .UNINDENT .INDENT 7.0 .INDENT 3.5 @@ -370526,12 +371613,12 @@ Make a tag for the job. .B user string The user to run the at job -\&.. versionadded:: 2014.1.4 +.. versionadded:: 2014.1.4 .TP .B unique_tag boolean If set to True job will not be added if a job with the tag exists. -\&.. versionadded:: 2017.7.0 +.. versionadded:: 2017.7.0 .UNINDENT .INDENT 7.0 .INDENT 3.5 @@ -375456,7 +376543,7 @@ that contains a dict with region, key and keyid. .SS salt.states.boto3_elasticsearch .SS Manage Elasticsearch Service .sp -New in version Natrium. +New in version 3001. .INDENT 0.0 .TP @@ -375542,7 +376629,7 @@ to be completed. Default: \fBTrue\fP .UNINDENT .UNINDENT .sp -New in version Natrium. +New in version 3001. .sp Example: @@ -375578,7 +376665,7 @@ Note that this operation is blocking until the upgrade is complete. .UNINDENT .UNINDENT .sp -New in version Natrium. +New in version 3001. .sp Example: @@ -375776,7 +376863,7 @@ Enabled (bool): Specifies whether given log publishing option is enabled or not. .UNINDENT .UNINDENT .sp -New in version Natrium. +New in version 3001. .sp Example: @@ -375841,7 +376928,7 @@ on the Elasticsearch domain, or add (\fBFalse\fP) tags to the ES domain. .UNINDENT .UNINDENT .sp -New in version Natrium. +New in version 3001. .UNINDENT .INDENT 0.0 @@ -375864,7 +376951,7 @@ the Elasticsearch domain eg. "1.5" or "2.3". .UNINDENT .UNINDENT .sp -New in version Natrium. +New in version 3001. .sp Example: @@ -380469,28 +381556,20 @@ considering a target unhealthy. The default is 2. (bool) \- True on success, False on failure. .UNINDENT .sp -CLI example: -\&.. code\-block:: yaml +CLI Example: .INDENT 7.0 .INDENT 3.5 -.INDENT 0.0 -.TP -.B create\-target: -.INDENT 7.0 -.TP -.B boto_elb2.create_targets_group: -.INDENT 7.0 -.IP \(bu 2 -name: myALB -.IP \(bu 2 -protocol: https -.IP \(bu 2 -port: 443 -.IP \(bu 2 -vpc_id: myVPC -.UNINDENT -.UNINDENT -.UNINDENT +.sp +.nf +.ft C +create\-target: + boto_elb2.create_targets_group: + \- name: myALB + \- protocol: https + \- port: 443 + \- vpc_id: myVPC +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -380507,7 +381586,7 @@ Delete target group. (bool) \- True on success, False on failure. .UNINDENT .sp -CLI example: +CLI Example: .INDENT 7.0 .INDENT 3.5 .sp @@ -380537,7 +381616,7 @@ The ARN of the Application Load Balancer Target Group to remove targets from. A list of target IDs or a string of a single target registered to the target group to be removed .UNINDENT .sp -New in version Unknown. +New in version 2017.7.0. .INDENT 7.0 .INDENT 3.5 @@ -385594,7 +386673,7 @@ User to set privilege to .SS salt.states.chocolatey .sp Manage Chocolatey package installs -\&.. versionadded:: 2016.3.0 +.. versionadded:: 2016.3.0 .sp \fBNOTE:\fP .INDENT 0.0 @@ -386100,6 +387179,9 @@ user_configuration: .SS salt.states.cisconso .sp State module for Cisco NSO Proxy minions +.sp +New in version 2016.11.0. + .sp For documentation on setting up the cisconso proxy minion look in the documentation for \fBsalt.proxy.cisconso\fP\&. @@ -391934,6 +393016,9 @@ myuser/myimage: .fi .UNINDENT .UNINDENT +.sp +New in version 2017.7.0. + .sp Changed in version 2018.3.0: The \fBtag\fP must be manually specified using the \fBtag\fP argument. @@ -392896,6 +393981,7 @@ portgroups (DVportgroups). .B codeauthor \fIAlexandru Bleotu \fP .UNINDENT +.sp Examples .sp Several settings can be changed for DVSs and DVporgroups. Here are two examples @@ -393661,6 +394747,38 @@ Configuration applied to the cluster. Complex datastructure following the ESXClusterConfigSchema. Valid example is: .UNINDENT +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +drs: + default_vm_behavior: fullyAutomated + enabled: true + vmotion_rate: 3 +ha: + admission_control + _enabled: false + default_vm_settings: + isolation_response: powerOff + restart_priority: medium + enabled: true + hb_ds_candidate_policy: userSelectedDs + host_monitoring: enabled + options: + \- key: das.ignoreinsufficienthbdatastore + value: \(aqtrue\(aq + vm_monitoring: vmMonitoringDisabled +vm_swap_placement: vmDirectory +vsan: + auto_claim_storage: false + compression_enabled: true + dedup_enabled: true + enabled: true +.ft P +.fi +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -394162,7 +395280,7 @@ configure\-host\-password: .UNINDENT .INDENT 0.0 .TP -.B salt.states.esxi.ssh_configured(name, service_running, ssh_key=None, ssh_key_file=None, service_policy=None, service_restart=False, certificate_verify=False) +.B salt.states.esxi.ssh_configured(name, service_running, ssh_key=None, ssh_key_file=None, service_policy=None, service_restart=False, certificate_verify=None) Manage the SSH configuration for a host including whether or not SSH is running or the presence of a given SSH key. Note: Only one ssh key can be uploaded for root. Uploading a second key will replace any existing key. @@ -394205,7 +395323,7 @@ previous running state. Default is \fBFalse\fP\&. .TP .B certificate_verify If set to \fBTrue\fP, the SSL connection must present a valid certificate. -Default is \fBFalse\fP\&. +Default is \fBTrue\fP\&. .UNINDENT .sp Example: @@ -395929,14 +397047,14 @@ content block will be prepended to the file. If markers are not found, this parameter can be set to a regex which will insert the block before the first found occurrence in the file. .sp -New in version Sodium. +New in version 3001. .TP .B insert_after_match If markers are not found, this parameter can be set to a regex which will insert the block after the first found occurrence in the file. .sp -New in version Sodium. +New in version 3001. .TP .B backup @@ -397903,7 +399021,7 @@ Allows setting the selinux user, role, type, and range of a managed file .UNINDENT .UNINDENT .sp -New in version Neon. +New in version 3000. .TP .B win_owner @@ -398085,6 +399203,19 @@ Usage: .sp New in version 0.17.0. +.UNINDENT +.INDENT 0.0 +.TP +.B salt.states.file.mod_beacon(name, **kwargs) +Create a beacon to monitor a file based on a beacon state argument. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +This state exists to support special handling of the \fBbeacon\fP +state argument for supported state functions. It should not be called directly. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP @@ -399314,7 +400445,7 @@ True, the existing entry in the way of the symlink file will be deleted to make room for the symlink, unless backupname is set, when it will be renamed .sp -Changed in version Neon: Force will now remove all types of existing file system entries, +Changed in version 3000: Force will now remove all types of existing file system entries, not just files, directories and symlinks. .TP @@ -399728,7 +400859,7 @@ List of services to add to the zone. .B prune_services False If \fBTrue\fP, remove all but the specified services from the zone. -\&.. note:: Currently defaults to True for compatibility, but will be changed to False in a future release. +.. note:: Currently defaults to True for compatibility, but will be changed to False in a future release. .TP .B interfaces None @@ -400820,7 +401951,7 @@ New in version 2018.3.1. .sp Github User State Module .sp -New in version 2016.3.0.. +New in version 2016.3.0. .sp This state is used to ensure presence of users in the Organization. @@ -401076,40 +402207,6 @@ Ensure team test_mfa is present in github: .sp New in version 2016.11.0. -.UNINDENT -.SS salt.states.glance -.SS Managing Images in OpenStack Glance -.INDENT 0.0 -.TP -.B salt.states.glance.image_present(name, visibility=\(aqpublic\(aq, protected=None, checksum=None, location=None, disk_format=\(aqraw\(aq, wait_for=None, timeout=30) -Checks if given image is present with properties -set as specified. -.sp -An image should got through the stages \(aqqueued\(aq, \(aqsaving\(aq -before becoming \(aqactive\(aq. The attribute \(aqchecksum\(aq can -only be checked once the image is active. -If you don\(aqt specify \(aqwait_for\(aq but \(aqchecksum\(aq the function -will wait for the image to become active before comparing -checksums. If you don\(aqt specify checksum either the function -will return when the image reached \(aqsaving\(aq. -The default timeout for both is 30 seconds. -.INDENT 7.0 -.TP -.B Supported properties: -.INDENT 7.0 -.IP \(bu 2 -visibility (\(aqpublic\(aq or \(aqprivate\(aq) -.IP \(bu 2 -protected (bool) -.IP \(bu 2 -checksum (string, md5sum) -.IP \(bu 2 -location (URL, to copy from) -.IP \(bu 2 -disk_format (\(aqraw\(aq (default), \(aqvhd\(aq, \(aqvhdx\(aq, \(aqvmdk\(aq, \(aqvdi\(aq, \(aqiso\(aq, -\(aqqcow2\(aq, \(aqaki\(aq, \(aqari\(aq or \(aqami\(aq) -.UNINDENT -.UNINDENT .UNINDENT .SS salt.states.glance_image .SS Management of OpenStack Glance Images @@ -401173,7 +402270,7 @@ An arbitrary description of the image .SS salt.states.glassfish .sp Manage Glassfish/Payara server -\&.. versionadded:: Carbon +.. versionadded:: 2016.11.0 .sp Management of glassfish using its RESTful API You can setup connection parameters like this @@ -402597,17 +403694,17 @@ destructive is False, set the grain\(aqs value to None. Defaults to False. If force is True, the existing grain will be overwritten regardless of its existing or provided value type. Defaults to False .sp -New in version v2015.8.2. +New in version 2015.8.2. .TP .B delimiter A delimiter different from the default can be provided. .sp -New in version v2015.8.2. +New in version 2015.8.2. .UNINDENT .sp -Changed in version v2015.8.2. +Changed in version 2015.8.2. .sp This state now support nested grains and complex values. It is also more @@ -402649,7 +403746,7 @@ is given. Defaults to False. .B delimiter A delimiter different from the default can be provided. .sp -New in version v2015.8.2. +New in version 2015.8.2. .UNINDENT .INDENT 7.0 @@ -402698,7 +403795,7 @@ The value to delete from the grain list. .B delimiter A delimiter different from the default \fB:\fP can be provided. .sp -New in version v2015.8.2. +New in version 2015.8.2. .UNINDENT .sp @@ -402752,7 +403849,7 @@ The value is present in the list type grain. .B delimiter A delimiter different from the default \fB:\fP can be provided. .sp -New in version v2015.8.2. +New in version 2015.8.2. .UNINDENT .sp @@ -402809,7 +403906,7 @@ contains complex objects. .B salt.states.grains.present(name, value, delimiter=\(aq:\(aq, force=False) Ensure that a grain is set .sp -Changed in version v2015.8.2. +Changed in version 2015.8.2. .INDENT 7.0 .TP @@ -402823,13 +403920,13 @@ The value to set on the grain If force is True, the existing grain will be overwritten regardless of its existing or provided value type. Defaults to False .sp -New in version v2015.8.2. +New in version 2015.8.2. .TP .B delimiter A delimiter different from the default can be provided. .sp -New in version v2015.8.2. +New in version 2015.8.2. .UNINDENT .sp @@ -403879,7 +404976,7 @@ ifttt\-event: .UNINDENT .sp The api key can be specified in the master or minion configuration like below: -\&.. code\-block:: yaml +.. code\-block:: yaml .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 @@ -408013,6 +409110,9 @@ k8s\-secret: .fi .UNINDENT .UNINDENT +.sp +New in version 2017.7.0. + .INDENT 0.0 .TP .B salt.states.kubernetes.configmap_absent(name, namespace=\(aqdefault\(aq, **kwargs) @@ -408966,7 +410066,9 @@ libcloud_storage: .UNINDENT .UNINDENT .UNINDENT -Examples.SS Creating a container and uploading a file +.sp +Examples +.SS Creating a container and uploading a file .INDENT 0.0 .INDENT 3.5 .sp @@ -409338,7 +410440,7 @@ salt.modulus.logadm Oracle Solaris, Sun Solaris, illumos .UNINDENT .sp -New in version nitrogen. +New in version 2017.7.0. .INDENT 0.0 .INDENT 3.5 @@ -409631,7 +410733,9 @@ The name of the Logical Volume The name of the Volume Group on which the Logical Volume resides .TP .B size -The size of the Logical Volume +The size of the Logical Volume in megabytes, or use a suffix +such as S, M, G, T, P for 512 byte sectors, megabytes, gigabytes +or terabytes respectively. The suffix is case insensitive. .TP .B extents The number of logical extents allocated to the Logical Volume @@ -409649,7 +410753,7 @@ Any supported options to lvcreate. See \fBlinux_lvm\fP for more details. .UNINDENT .sp -New in version to_complete. +New in version 2016.11.0. .INDENT 7.0 .TP @@ -415679,6 +416783,9 @@ configuration would saved in the file: .UNINDENT .SS salt.states.netntp .SS Network NTP +.sp +New in version 2016.11.0. + .sp Manage the configuration of NTP peers and servers on the network devices through the NAPALM proxy. .INDENT 0.0 @@ -415791,6 +416898,9 @@ unix .IP \(bu 2 \fBnapalm snmp management module (salt.modules.napalm_snmp)\fP .UNINDENT +.sp +New in version 2016.11.0. + .INDENT 0.0 .TP .B salt.states.netsnmp.managed(name, config=None, defaults=None) @@ -415929,7 +417039,12 @@ netusers_example: CLI Example: .INDENT 7.0 .INDENT 3.5 +.sp +.nf +.ft C salt \(aqedge01.kix01\(aq state.sls router.users +.ft P +.fi .UNINDENT .UNINDENT .sp @@ -416210,6 +417325,11 @@ eth0: \- dns: \- 8.8.8.8 \- 8.8.4.4 + \- channels: + rx: 4 + tx: 4 + other: 4 + combined: 4 .ft P .fi .UNINDENT @@ -416574,7 +417694,7 @@ The name of the interface to manage eth Type of interface and configuration .sp -Changed in version Sodium?. +Changed in version 3002. .TP .B enabled @@ -417681,6 +418801,9 @@ A list of NTP servers .SS salt.states.nxos .sp State module for Cisco NX\-OS Switch Proxy and Native minions +.sp +New in version 2016.11.0. + .sp For documentation on setting up the nxos proxy minion look in the documentation for \fBsalt.proxy.nxos\fP\&. @@ -417886,6 +419009,9 @@ update: .SS salt.states.nxos_upgrade .sp Manage NX\-OS System Image Upgrades. +.sp +New in version 3001. + .INDENT 0.0 .TP .B maturity @@ -418459,7 +419585,9 @@ ensure my cloudwatch service exists: .SS salt.states.pagerduty_user .sp Manage PagerDuty users. -Example.INDENT 0.0 +.sp +Example +.INDENT 0.0 .INDENT 3.5 .sp .nf @@ -419252,7 +420380,9 @@ panos/hostname: .sp Manages VMware storage policies (called pbm because the vCenter endpoint is /pbm) -Examples.SS Storage policy +.sp +Examples +.SS Storage policy .INDENT 0.0 .INDENT 3.5 .sp @@ -421624,10 +422754,16 @@ module for your OS, it is ignored. \fBhold\fP (\fI\%bool\fP) \-\- .sp Force the package to be held at the current installed version. -Currently works with YUM/DNF & APT based systems. +.sp +Supported on YUM/DNF & APT based systems. .sp New in version 2014.7.0. +.sp +Supported on Zypper\-based systems. +.sp +New in version 3003. + .IP \(bu 2 \fBupdate_holds\fP (\fI\%bool\fP) \-\- @@ -421638,10 +422774,15 @@ can be updated. Otherwise, if this function attempts to update a held package, the held package(s) will be skipped and the state will fail. By default, this parameter is set to \fBFalse\fP\&. .sp -Currently works with YUM/DNF & APT based systems. +Supported on YUM/DNF & APT based systems. .sp New in version 2016.11.0. +.sp +Supported on Zypper\-based systems. +.sp +New in version 3003. + .IP \(bu 2 \fBnames\fP (\fI\%list\fP) \-\- @@ -422124,6 +423265,20 @@ low chunks and merges them into a single pkgs ref in the present low data .UNINDENT .INDENT 0.0 .TP +.B salt.states.pkg.mod_beacon(name, **kwargs) +Create a beacon to monitor a package or packages +based on a beacon state argument. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +This state exists to support special handling of the \fBbeacon\fP +state argument for supported state functions. It should not be called directly. +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP .B salt.states.pkg.mod_watch(name, **kwargs) Install/reinstall a package based on a watch requisite .sp @@ -423384,7 +424539,7 @@ Version of the postgresql server of the cluster to remove .B name The name of the cluster to remove .sp -New in version 2015.XX. +New in version 2016.3.0. .UNINDENT .UNINDENT @@ -423422,7 +424577,7 @@ Use checksums on data pages .B wal_segsize Set the WAL segment size, in megabytes .sp -New in version 2015.XX. +New in version 2016.3.0. .UNINDENT .UNINDENT @@ -423688,7 +424843,18 @@ Is the group allowed to create databases? Is the group allowed to create other roles/users .TP .B encrypted -Should the password be encrypted in the system catalog? +How the password should be stored. +.sp +If encrypted is \fBNone\fP, \fBTrue\fP, or \fBmd5\fP, it will use +PostgreSQL\(aqs MD5 algorithm. +.sp +If encrypted is \fBFalse\fP, it will be stored in plaintext. +.sp +If encrypted is \fBscram\-sha\-256\fP, it will use the algorithm described +in RFC 7677. +.sp +Changed in version 3003: Prior versions only supported \fBTrue\fP and \fBFalse\fP + .TP .B login Should the group have login perm @@ -423703,21 +424869,23 @@ Should the new group be a "superuser" Should the new group be allowed to initiate streaming replication .TP .B password -The group\(aqs password -It can be either a plain string or a md5 postgresql hashed password: +The group\(aqs password. +It can be either a plain string or a pre\-hashed password: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C \(aqmd5{MD5OF({password}{role}}\(aq +\(aqSCRAM\-SHA\-256${iterations}:{salt}${stored_key}:{server_key}\(aq .ft P .fi .UNINDENT .UNINDENT .sp -If encrypted is \fBNone\fP or \fBTrue\fP, the password will be automatically -encrypted to the previous format if it is not already done. +If encrypted is not \fBFalse\fP, then the password will be converted +to the appropriate format above, if not already. As a consequence, +passwords that start with "md5" or "SCRAM\-SHA\-256" cannot be used. .TP .B refresh_password Password refresh flag @@ -424432,7 +425600,7 @@ Database port if different from config or default .B salt.states.postgres_user.present(name, createdb=None, createroles=None, encrypted=None, superuser=None, replication=None, inherit=None, login=None, password=None, default_password=None, refresh_password=None, valid_until=None, groups=None, user=None, maintenance_db=None, db_password=None, db_host=None, db_port=None, db_user=None) Ensure that the named user is present with the specified privileges Please note that the user/group notion in postgresql is just abstract, we -have roles, where users can be seens as roles with the LOGIN privilege +have roles, where users can be seen as roles with the LOGIN privilege and groups the others. .INDENT 7.0 .TP @@ -424446,7 +425614,18 @@ Is the user allowed to create databases? Is the user allowed to create other users? .TP .B encrypted -Should the password be encrypted in the system catalog? +How the password should be stored. +.sp +If encrypted is \fBNone\fP, \fBTrue\fP, or \fBmd5\fP, it will use +PostgreSQL\(aqs MD5 algorithm. +.sp +If encrypted is \fBFalse\fP, it will be stored in plaintext. +.sp +If encrypted is \fBscram\-sha\-256\fP, it will use the algorithm described +in RFC 7677. +.sp +Changed in version 3003: Prior versions only supported \fBTrue\fP and \fBFalse\fP + .TP .B login Should the group have login perm @@ -424461,22 +425640,23 @@ Should the new user be a "superuser" Should the new user be allowed to initiate streaming replication .TP .B password -The system user\(aqs password. It can be either a plain string or a -md5 postgresql hashed password: +The user\(aqs password. +It can be either a plain string or a pre\-hashed password: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C \(aqmd5{MD5OF({password}{role}}\(aq +\(aqSCRAM\-SHA\-256${iterations}:{salt}${stored_key}:{server_key}\(aq .ft P .fi .UNINDENT .UNINDENT .sp -If encrypted is None or True, the password will be automatically -encrypted to the previous -format if it is not already done. +If encrypted is not \fBFalse\fP, then the password will be converted +to the appropriate format above, if not already. As a consequence, +passwords that start with "md5" or "SCRAM\-SHA\-256" cannot be used. .TP .B default_password The password used only when creating the user, unless password is set. @@ -424582,6 +425762,9 @@ unix .IP \(bu 2 \fBnapalm probes management module\fP .UNINDENT +.sp +New in version 2016.11.0. + .INDENT 0.0 .TP .B salt.states.probes.managed(name, probes, defaults=None) @@ -424804,7 +425987,7 @@ pushover\-message: .UNINDENT .sp The api key can be specified in the master or minion configuration like below: -\&.. code\-block:: yaml +.. code\-block:: yaml .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 @@ -425790,6 +426973,9 @@ list of keys to ensure absent, name will be ignored if this is used .TP .B salt.states.redismod.slaveof(name, sentinel_host=None, sentinel_port=None, sentinel_password=None, **connection_args) Set this redis instance as a slave. +.sp +New in version 2016.3.0. + .INDENT 7.0 .TP .B name @@ -425869,6 +427055,7 @@ HKLMSOFTWAREPython Values or Entries are the name/data pairs beneath the keys and subkeys. All keys have a default name/data pair. The name is \fB(Default)\fP with a displayed value of \fB(value not set)\fP\&. The actual value is Null. +.sp Example .sp The following example is taken from the windows startup portion of the registry: @@ -426706,24 +427893,17 @@ on a minion. Set up pillar data for your proxies per the documentation. .sp Run the state as below -.sp -\&..code\-block:: yaml .INDENT 0.0 .INDENT 3.5 -.INDENT 0.0 -.TP -.B salt\-proxy\-configure: -.INDENT 7.0 -.TP -.B salt_proxy.configure_proxy: -.INDENT 7.0 -.IP \(bu 2 -proxyname: p8000 -.IP \(bu 2 -start: True -.UNINDENT -.UNINDENT -.UNINDENT +.sp +.nf +.ft C +salt\-proxy\-configure: + salt_proxy.configure_proxy: + \- proxyname: p8000 + \- start: True +.ft P +.fi .UNINDENT .UNINDENT .sp @@ -426750,24 +427930,17 @@ if required .UNINDENT .sp Example: -.sp -\&..code\-block:: yaml .INDENT 7.0 .INDENT 3.5 -.INDENT 0.0 -.TP -.B salt\-proxy\-configure: -.INDENT 7.0 -.TP -.B salt_proxy.configure_proxy: -.INDENT 7.0 -.IP \(bu 2 -proxyname: p8000 -.IP \(bu 2 -start: True -.UNINDENT -.UNINDENT -.UNINDENT +.sp +.nf +.ft C +salt\-proxy\-configure: + salt_proxy.configure_proxy: + \- proxyname: p8000 + \- start: True +.ft P +.fi .UNINDENT .UNINDENT .UNINDENT @@ -426779,6 +427952,9 @@ sending commands down to minions as well as access to executing master\-side modules. These state functions wrap Salt\(aqs Python API\&. .INDENT 0.0 .INDENT 3.5 +New in version 2016.11.0. + +.sp Support for masterless minions was added to the \fBsalt.state\fP function, so they can run orchestration sls files. This is particularly useful when the rendering of a state is dependent on the execution of another state. @@ -426864,7 +428040,7 @@ New in version 2019.2.2. .B salt.states.saltmod.parallel_runners(name, runners, **kwargs) Executes multiple runner modules on the master in parallel. .sp -New in version 2017.x.0: (Nitrogen) +New in version 2018.3.0. .sp A separate thread is spawned for each runner. This state is intended to be @@ -426945,6 +428121,9 @@ An arbitrary name used to track the state execution .TP .B tgt The target specification for the state run. +.sp +New in version 2016.11.0. + .sp Masterless support: When running on a masterless minion, the \fBtgt\fP is ignored and will always be the local minion. @@ -427171,6 +428350,8 @@ from a states. Rather than needing to to use \fBmodule.run\fP this state allows improved change detection. .INDENT 0.0 .INDENT 3.5 +New in version 3000. + .UNINDENT .UNINDENT .INDENT 0.0 @@ -428370,6 +429551,19 @@ unmask_indefinite_foo: .UNINDENT .INDENT 0.0 .TP +.B salt.states.service.mod_beacon(name, **kwargs) +Create a beacon to monitor a service based on a beacon state argument. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +This state exists to support special handling of the \fBbeacon\fP +state argument for supported state functions. It should not be called directly. +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP .B salt.states.service.mod_watch(name, sfun=None, sig=None, reload=False, full_restart=False, init_delay=None, force=False, **kwargs) The service watcher, called to invoke the watch command. When called, it will restart or reload the named service. @@ -429299,7 +430493,7 @@ options to ensure .sp Splunk User State Module .sp -New in version 2016.3.0.. +New in version 2016.3.0. .sp This state is used to ensure presence of users in splunk. @@ -430001,7 +431195,7 @@ was originally hashed with. This defaults to \fBsha256\fP if not specified. New in version 2016.11.4. .sp -Changed in version 2017.7.0:: default changed from \fBmd5\fP to \fBsha256\fP +Changed in version 2017.7.0: default changed from \fBmd5\fP to \fBsha256\fP .UNINDENT .UNINDENT @@ -431133,7 +432327,9 @@ conf/tomcat\-users.xml .fi .UNINDENT .UNINDENT -Notes.INDENT 0.0 +.sp +Notes +.INDENT 0.0 .IP \(bu 2 Using multiple versions (aka. parallel deployments) on the same context path is not supported. @@ -432630,7 +433826,7 @@ cpu: .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -432752,7 +433948,7 @@ policy for domain process. The optional \fBmemory\fP element specifies how to al on a NUMA host. \fBmemnode\fP elements can specify memory allocation policies per each guest NUMA node. The definition used in the dictionary can be found at init\-cpu\-def\&. .sp -New in version Aluminium. +New in version 3003. .INDENT 2.0 .INDENT 3.5 @@ -432773,7 +433969,7 @@ New in version Aluminium. .sp Enable or disable hypervisor\-specific features on the virtual machine. .sp -New in version Aluminium. +New in version 3003. .INDENT 2.0 .INDENT 3.5 @@ -432810,11 +434006,11 @@ This configuration is a dictionary with the properties \fBtrack\fP, \fBtickpolic See \fI\%libvirt time keeping documentation\fP for the possible values. .UNINDENT .sp -New in version Aluminium. +New in version 3003. .sp Set the clock to local time using an offset in seconds -\&.. code\-block:: yaml +.. code\-block:: yaml .INDENT 2.0 .INDENT 3.5 .INDENT 0.0 @@ -432845,7 +434041,7 @@ clock: Dictionary providing details on the serials connection to create. (Default: \fBNone\fP) See init\-chardevs\-def for more details on the possible values. .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -432854,7 +434050,7 @@ New in version Aluminium. Dictionary providing details on the consoles device to create. (Default: \fBNone\fP) See init\-chardevs\-def for more details on the possible values. .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -432865,7 +434061,7 @@ This is specially useful when creating a virtual machine with an installation cd an autoinstallation needing a special first boot configuration. Defaults to \fBFalse\fP .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -432874,7 +434070,7 @@ New in version Aluminium. If set to \fBFalse\fP the changes will not be applied live to the running instance, but will only apply at the next start. Note that reboot will not take those changes. .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -432884,11 +434080,12 @@ List of host devices to passthrough to the guest. The value is a list of device names as provided by the \fBnode_devices()\fP function. (Default: \fBNone\fP) .sp -New in version Aluminium. +New in version 3003. .UNINDENT .UNINDENT +.sp Example States .sp Make sure a virtual machine called \fBdomain_name\fP is defined: @@ -433008,7 +434205,7 @@ Defines a new network with specified arguments. .sp Forward mode(bridge, router, nat) .sp -Changed in version Aluminium: a \fBNone\fP value creates an isolated network with no forwarding at all +Changed in version 3003: a \fBNone\fP value creates an isolated network with no forwarding at all .IP \(bu 2 @@ -433031,7 +434228,7 @@ The \fBparameters\fP value is a dictionary of virtual port parameters. .UNINDENT .UNINDENT .sp -Changed in version Aluminium: possible dictionary value +Changed in version 3003: possible dictionary value .IP \(bu 2 @@ -433058,7 +434255,7 @@ The \fBnativeMode\fP value can be one of \fBtagged\fP or \fBuntagged\fP\&. .UNINDENT .UNINDENT .sp -Changed in version Aluminium: possible dictionary value +Changed in version 3003: possible dictionary value .IP \(bu 2 @@ -433085,7 +434282,7 @@ for more details on this dictionary. size of the Maximum Transmission Unit (MTU) of the network. (default \fBNone\fP) .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -433107,7 +434304,7 @@ The value is a dictionary with a mandatory \fBname\fP property and an optional \ .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -433135,7 +434332,7 @@ Both values are a dictionary with \fBstart\fP and \fBend\fP values. .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -433155,7 +434352,7 @@ whitespace separated list of network interfaces devices that can be used for thi .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -433175,7 +434372,7 @@ whitespace separated list of addreses of PCI devices that can be used for this n .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -433195,7 +434392,7 @@ device name of the physical interface to use in \fBhostdev\fP forward mode. .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -433235,7 +434432,7 @@ The value is a dictionary described in net\-define\-dns\&. .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .UNINDENT @@ -433309,7 +434506,7 @@ Defines and starts a new network with specified arguments. .sp Forward mode(bridge, router, nat) .sp -Changed in version Aluminium: a \fBNone\fP value creates an isolated network with no forwarding at all +Changed in version 3003: a \fBNone\fP value creates an isolated network with no forwarding at all .IP \(bu 2 @@ -433332,7 +434529,7 @@ The \fBparameters\fP value is a dictionary of virtual port parameters. .UNINDENT .UNINDENT .sp -Changed in version Aluminium: possible dictionary value +Changed in version 3003: possible dictionary value .IP \(bu 2 @@ -433359,7 +434556,7 @@ The \fBnativeMode\fP value can be one of \fBtagged\fP or \fBuntagged\fP\&. .UNINDENT .UNINDENT .sp -Changed in version Aluminium: possible dictionary value +Changed in version 3003: possible dictionary value .IP \(bu 2 @@ -433416,7 +434613,7 @@ New in version 2019.2.0. size of the Maximum Transmission Unit (MTU) of the network. (default \fBNone\fP) .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -433438,7 +434635,7 @@ The value is a dictionary with a mandatory \fBname\fP property and an optional \ .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -433466,7 +434663,7 @@ Both values are a dictionary with \fBstart\fP and \fBend\fP values. .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -433486,7 +434683,7 @@ whitespace separated list of network interfaces devices that can be used for thi .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -433506,7 +434703,7 @@ whitespace separated list of addreses of PCI devices that can be used for this n .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -433526,7 +434723,7 @@ device name of the physical interface to use in \fBhostdev\fP forward mode. .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -433566,7 +434763,7 @@ The value is a dictionary described in net\-define\-dns\&. .UNINDENT .UNINDENT .sp -New in version Aluminium. +New in version 3003. .UNINDENT @@ -433707,6 +434904,18 @@ In order to be purged a storage pool needs to be running to get the list of volu Some libvirt storage drivers may not implement deleting, those actions are implemented on a best effort idea. In any case check the result\(aqs comment property to see if any of the action was unsupported. +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +pool_name: + uyuni_virt.pool_deleted: + \- purge: True +.ft P +.fi +.UNINDENT +.UNINDENT .sp New in version 3000. @@ -434115,7 +435324,7 @@ New in version 3000. Dictionary providing details on the serials connection to create. (Default: \fBNone\fP) See init\-chardevs\-def for more details on the possible values. .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -434124,7 +435333,7 @@ New in version Aluminium. Dictionary providing details on the consoles device to create. (Default: \fBNone\fP) See init\-chardevs\-def for more details on the possible values. .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -434150,7 +435359,7 @@ To update any numatune parameters, specify the new value. To remove any \fBnumat for instance: \(aqnumatune\(aq: \fBNone\fP\&. Please note that \fBNone\fP is mapped to \fBnull\fP in sls file, pass \fBnull\fP in sls file instead. .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -434161,7 +435370,7 @@ This is specially useful when creating a virtual machine with an installation cd an autoinstallation needing a special first boot configuration. Defaults to \fBFalse\fP .sp -New in version Aluminium. +New in version 3003. .IP \(bu 2 @@ -434169,7 +435378,7 @@ New in version Aluminium. .sp Enable or disable hypervisor\-specific features on the virtual machine. .sp -New in version Aluminium. +New in version 3003. .INDENT 2.0 .INDENT 3.5 @@ -434206,11 +435415,11 @@ This configuration is a dictionary with the properties \fBtrack\fP, \fBtickpolic See \fI\%libvirt time keeping documentation\fP for the possible values. .UNINDENT .sp -New in version Aluminium. +New in version 3003. .sp Set the clock to local time using an offset in seconds -\&.. code\-block:: yaml +.. code\-block:: yaml .INDENT 2.0 .INDENT 3.5 .INDENT 0.0 @@ -434242,11 +435451,12 @@ List of host devices to passthrough to the guest. The value is a list of device names as provided by the \fBnode_devices()\fP function. (Default: \fBNone\fP) .sp -New in version Aluminium. +New in version 3003. .UNINDENT .UNINDENT +.sp Example States .sp Make sure an already\-defined virtual machine called \fBdomain_name\fP is running: @@ -434495,6 +435705,7 @@ The base volume format will not be guessed for security reasons and is thus mand \fBpassword\fP \-\- password to connect with, overriding defaults .UNINDENT .UNINDENT +.sp CLI Example: .sp Volume on ESX: @@ -434919,6 +436130,7 @@ targeted. Default is None. \fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the install .UNINDENT .UNINDENT +.sp Example .sp Run \fBdism.available_capabilities\fP to get a list of available @@ -434954,6 +436166,7 @@ targeted. Default is None. \fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the install .UNINDENT .UNINDENT +.sp Example .sp Run \fBdism.installed_capabilities\fP to get a list of installed @@ -435001,6 +436214,7 @@ targeted. Default is None. \fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the install .UNINDENT .UNINDENT +.sp Example .sp Run \fBdism.available_features\fP to get a list of available features. @@ -435039,6 +436253,7 @@ targeted. Default is None. \fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the install .UNINDENT .UNINDENT +.sp Example .sp Run \fBdism.installed_features\fP to get a list of installed features. @@ -435082,7 +436297,9 @@ targeted. Default is None. \fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the install .UNINDENT .UNINDENT -Example.INDENT 7.0 +.sp +Example +.INDENT 7.0 .INDENT 3.5 .sp .nf @@ -435116,7 +436333,9 @@ targeted. Default is None. \fBrestart\fP (\fIOptional\fP\fI[\fP\fI\%bool\fP\fI]\fP) \-\- Reboot the machine if required by the install .UNINDENT .UNINDENT -Example.INDENT 7.0 +.sp +Example +.INDENT 7.0 .INDENT 3.5 .sp .nf @@ -436984,6 +438203,7 @@ be removed.\fP .UNINDENT .UNINDENT +.sp Example .sp Do not use the role or feature names mentioned in the PKGMGR @@ -437078,6 +438298,7 @@ Some features require a reboot after uninstall. If so the feature will not be completely uninstalled until the server is restarted. .UNINDENT .UNINDENT +.sp Example .sp Do not use the role or feature names mentioned in the PKGMGR @@ -438287,25 +439508,25 @@ the mine where it can be easily retrieved by other minions. .sp .nf .ft C -salt\-minion: - service.running: - \- enable: True - \- watch: - \- file: /etc/salt/minion.d/x509.conf - /etc/salt/minion.d/x509.conf: file.managed: \- source: salt://x509.conf +restart\-salt\-minion: + cmd.run: + \- name: \(aqsalt\-call service.restart salt\-minion\(aq + \- bg: True + \- onchanges: + \- file: /etc/salt/minion.d/x509.conf + /etc/pki: file.directory /etc/pki/issued_certs: file.directory -/etc/pki/ca.crt: +/etc/pki/ca.key: x509.private_key_managed: - \- name: /etc/pki/ca.key \- bits: 4096 \- backup: True @@ -438435,7 +439656,7 @@ be considered valid. .UNINDENT .INDENT 0.0 .TP -.B salt.states.x509.certificate_managed(name, days_remaining=90, append_certs=None, managed_private_key=None, **kwargs) +.B salt.states.x509.certificate_managed(name, days_remaining=90, append_certs=None, **kwargs) Manage a Certificate .INDENT 7.0 .TP @@ -438454,10 +439675,6 @@ renewal. A list of certificates to be appended to the managed file. They must be valid PEM files, otherwise an error will be thrown. .TP -.B managed_private_key: -Has no effect since v2016.11 and will be removed in Salt Aluminium. -Use a separate x509.private_key_managed call instead. -.TP .B kwargs: Any arguments supported by \fBx509.create_certificate\fP or \fBfile.managed\fP are supported. .TP @@ -439895,7 +441112,7 @@ installed2 .UNINDENT .INDENT 0.0 .TP -.B salt.states.zcbuildout.installed(name, config=\(aqbuildout.cfg\(aq, quiet=False, parts=None, user=None, env=(), buildout_ver=None, test_release=False, distribute=None, new_st=None, offline=False, newest=False, python=\(aq/usr/bin/python3\(aq, debug=False, verbose=False, unless=None, onlyif=None, use_vt=False, loglevel=\(aqdebug\(aq, **kwargs) +.B salt.states.zcbuildout.installed(name, config=\(aqbuildout.cfg\(aq, quiet=False, parts=None, user=None, env=(), buildout_ver=None, test_release=False, distribute=None, new_st=None, offline=False, newest=False, python=\(aq/home/dscripter/git/saltopen/salt/.venv/bin/python3\(aq, debug=False, verbose=False, unless=None, onlyif=None, use_vt=False, loglevel=\(aqdebug\(aq, **kwargs) Install buildout in a specific directory .sp It is a thin wrapper to modules.buildout.buildout @@ -441048,7 +442265,7 @@ bool .UNINDENT .INDENT 0.0 .TP -.B salt.states.zookeeper.absent(name, version=\-1, recursive=False, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None) +.B salt.states.zookeeper.absent(name, version=\- 1, recursive=False, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None) Make sure znode is absent .INDENT 7.0 .TP @@ -441097,7 +442314,7 @@ delete znode: .UNINDENT .INDENT 0.0 .TP -.B salt.states.zookeeper.acls(name, acls, version=\-1, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None) +.B salt.states.zookeeper.acls(name, acls, version=\- 1, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None) Update acls on a znode .INDENT 7.0 .TP @@ -441151,7 +442368,7 @@ update acls: .UNINDENT .INDENT 0.0 .TP -.B salt.states.zookeeper.present(name, value, acls=None, ephemeral=False, sequence=False, makepath=False, version=\-1, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None) +.B salt.states.zookeeper.present(name, value, acls=None, ephemeral=False, sequence=False, makepath=False, version=\- 1, profile=None, hosts=None, scheme=None, username=None, password=None, default_acl=None) Make sure znode is present in the correct state with the correct acls .INDENT 7.0 .TP @@ -444766,7 +445983,7 @@ eauth user must be authorized to execute runner modules: (\fB@runner\fP). Only the \fBmaster_call()\fP below supports eauth. .INDENT 7.0 .TP -.B asynchronous(fun, low, user=\(aqUNKNOWN\(aq, pub=None) +.B asynchronous(fun, low, user=\(aqUNKNOWN\(aq, pub=None, local=True) Execute the function in a multiprocess and return the event tag to use to watch for the return .UNINDENT @@ -444852,7 +446069,7 @@ wheel = salt.wheel.WheelClient(opts) .UNINDENT .INDENT 7.0 .TP -.B asynchronous(fun, low, user=\(aqUNKNOWN\(aq, pub=None) +.B asynchronous(fun, low, user=\(aqUNKNOWN\(aq, pub=None, local=True) Execute the function in a multiprocess and return the event tag to use to watch for the return .UNINDENT @@ -457988,6 +459205,295 @@ information about the version numbering scheme. .sp Release Candidate .SS Previous Releases +.SS Salt 3003 Release Notes \- Codename Aluminium +.SS New Features +.SS SCRAM\-SHA\-256 support for PostgreSQL passwords +.sp +Support for SCRAM\-SHA\-256 password hashes has been added to the +\fBpostgres_user.present\fP +and \fBpostgres_group.present\fP +states. This allows migration away from the insecure and deprecated +previous storage methods. +.SS Added +.INDENT 0.0 +.IP \(bu 2 +Added "fips_mode" config option to master and minion configs. (#59427) +.IP \(bu 2 +Firewall groups support to Vultr Salt Cloud provider +.IP \(bu 2 +Adding the ability to clear and show the pillar cache enabled when pillar_cache is True. (#37080) +.IP \(bu 2 +SCRAM\-SHA\-256 support for PostgreSQL passwords. +Pass encrypted=scram\-sha\-256 to the postgres_user.present (or postgres_group.present) state. (#51271) +.IP \(bu 2 +The yumpkg module has been updated to support VMWare\(aqs Photon OS, which uses tdnf (a C implementation of dnf). "VMware Photon OS" has been added to the "RedHat" \fIos_family\fP map as part of this change. (#51912) +.IP \(bu 2 +The pkgrepo state now supports VMware Photon OS. (#52550) +.IP \(bu 2 +Added firewallgroups to Vultr Salt Cloud provider (#53677) +.IP \(bu 2 +Added arbitrary kwarg support for tojson filter. (#56012) +.IP \(bu 2 +Add salt monitor beacon to execute salt execution module functions. (#56461) +.IP \(bu 2 +Allow the nameservers to be populated from systemd\-resolve. (#57618) +.IP \(bu 2 +Adding reactor_niceness to the default minion configuration. (#57701) +.IP \(bu 2 +CPU model, topology and NUMA node tuning (#57880) +.IP \(bu 2 +Added \fBpkg.services_need_restart\fP which lists system services that should be restarted after package management operations. (#58261) +.IP \(bu 2 +Allow handling special first boot definition on virtual machine (#58589) +.IP \(bu 2 +Added vgcreate custom parameters to module call: addtag, alloc, autobackup, metadatatype, zero (#58747) +.IP \(bu 2 +Enhance console and serial support in virt module (#58844) +.IP \(bu 2 +Salt\(aqs versions report \fIsalt \-\-versions\-report\fP now includes all installed salt extensions into its versions report. (#58938) +.IP \(bu 2 +Support loading entrypoints by passing a module instead of a function. (#58939) +.IP \(bu 2 +Added shadow.gen_password for BSD operating systems. (#59140) +.IP \(bu 2 +Add more network and PCI/USB host devices passthrough support to virt module and states (#59143) +.IP \(bu 2 +Add interface channels management support to rh_ip module. (#59147) +.IP \(bu 2 +Add new minion option return_retry_tries for dynamic return retry tries (#59236) +.IP \(bu 2 +Added salt\-cloud support for Hetzner Cloud via the \fBhcloud\fP library of the provider. (#59301) +.IP \(bu 2 +"AlmaLinux" has been added to the "RedHat" \fIos_family\fP map (#59404) +.IP \(bu 2 +Added \fIblocks\fP and \fIattachments\fP params to the \fIslack_notify.post_message\fP function (#59428) +.IP \(bu 2 +Added tcp_reconnect_backoff minion config option for specifying reconnection backoff time for TCP transport (#59431) +.IP \(bu 2 +Added \fBswapusage\fP beacon to complement the existing \fBmemusage\fP beacon. (#59460) +.IP \(bu 2 +The \fIsalt\-run\fP CLI now accepts \fI\-\-jid\fP (#59527) +.IP \(bu 2 +Add bytes option for FreeBSD pkg\-stats(8) module. (#59540) +.IP \(bu 2 +Adding mod_beacon function to pkg, service, and file state modules. This function will act similar to the mod_watch function. This will allow supported functions in those state modules to automatically add associated beacons to monitor for changes to the respective resources in the state file and fire events to the event bus when changes occur. (#59559) +.IP \(bu 2 +Add \-B flag to FreeBSD pkgng.check() to regenerate the library dependency +metadata for a package by extracting library requirement information from the +binary ELF files in the package. (#59569) +.UNINDENT +.SS Changed +.INDENT 0.0 +.IP \(bu 2 +The \fBpkg\fP module now supports \fBtdnf\fP used by +VMWare Photon OS. As part of this change, \fBVMWare Photon OS\fP\(aqs +\fBos_family\fP grain will now resolve as \fBRedHat\fP\&. This may require changes +to existing uses of \fBgrains.filter_by\fP +.IP \(bu 2 +The \fBsalt\-run\fP CLI now accepts \fB\-\-jid\fP which allows scripting against it. +.IP \(bu 2 +Change \fIbrew cask \-\-list\fP to \fIbrew list \-\-cask\fP (#58381) +.IP \(bu 2 +Store git sha in salt/_version.py when installing from a tag so it can be found if needed later. (#59137) +.IP \(bu 2 +Changed package manager detection in yumpkg module (#59201) +.IP \(bu 2 +Updating the pkg beacon to fire the events when there are upgrades to packages, but also when watched packages are installed or removed. Breaking out the logic for listing pkgs from context into a separate function to aid in testing. Updating tests to ensure context is not used when use_context option to list_pkgs is False. (#59463) +.UNINDENT +.SS Removed +.INDENT 0.0 +.IP \(bu 2 +Removed the deprecated glance state and execution module in favor of the glance_image +state module and the glanceng execution module. (#59079) +.IP \(bu 2 +Removing the _ext_nodes deprecation warning and alias to the master_tops function. This change will break compatibility with a Salt master running versions 2017.7.8 and older and Salt minions running versions 3003 and newer. (#59804) +.IP \(bu 2 +removed the arg \fImanaged_private_key\fP from \(aqsalt.states.x509.certificate_managed\(aq (#59247) +.IP \(bu 2 +Drop support for python 3.5 on Windows (#59479) +.UNINDENT +.SS Deprecated +.INDENT 0.0 +.IP \(bu 2 +Added deprecation warning for grains.get_or_set_hash (#59425) +.UNINDENT +.SS Fixed +.INDENT 0.0 +.IP \(bu 2 +When instantiating the loader grab values of grains and pillars if +they are NamedLoaderContext instances. (#59773) +.IP \(bu 2 +Fixed installation on Apple Silicon Macs by checking $HOMEBREW_PREFIX for \fIlibcrypto\fP instead of assuming /usr/local. (#59808) +.IP \(bu 2 +The Google Cloud Engine salt\-cloud provider now requires \fIapache\-libcloud>=2.5.0\fP\&. Service account authentication is broken on older versions. +.IP \(bu 2 +Fix incorrect documentation for pillar_source_merging_strategy (#26396) +.IP \(bu 2 +Don\(aqt iterate through cloud map errors (#34033) +.IP \(bu 2 +Supress noisy warnings when very old pyzmq is used. (#50327) +.IP \(bu 2 +Fixed glusterfs version parsing for pre\-4.0 (#50707) +.IP \(bu 2 +Prevent traceback when trying to list reactors when none are configured. (#53334) +.IP \(bu 2 +Fixed zabbix_host.present to accept all Zabbix host properties (#53838) +.IP \(bu 2 +Binaries for the salt installer package for OSX are now signed and the installer +package is notarized (#54513) +.IP \(bu 2 +Guard boto3_elasticsearch loading properly (#55848) +.IP \(bu 2 +Use a capitalized string version of the value of \fINodeState\fP instead (#56589) +.IP \(bu 2 +Adding missing error case to the validation for service beacon. (#56623) +.IP \(bu 2 +The GCE cloud driver only works with apache\-libcloud>=2.5.0, prior versions have authentication issues (#56862) +.IP \(bu 2 +zypperpkg add_lock and remove_lock examples do not work (#56922) +.IP \(bu 2 +Compare bytes to bytes so we don\(aqt overwrite a correct value (#57212) +.IP \(bu 2 +Fixing expand_repo_def in aptpkg module to include the architecture in the line attribute when it is passed in. (#57600) +.IP \(bu 2 +When passing arguments pass them as keyword arguments so that we can be sure the right value is going where. (#58006, #58579, #59075) +.IP \(bu 2 +Improve module whitelist logic for file backends (#58041) +.IP \(bu 2 +Fix behavior for "onlyif/unless" state conditionals when multiple declarations (#58085) +.IP \(bu 2 +Ensure data is a valid keyword argument for the event.wait function. (#58182) +.IP \(bu 2 +Do not raise "StreamClosedError" traceback on the master logs but only log it (#58301) +.IP \(bu 2 +Fixed issue with win_timezone when dst is turned off. This was causing the +minion not to start +Use default timezone offset in scheduler when correct timezone cannot be determined (#58379) +.IP \(bu 2 +Pop!_OS 20.04 and 20.10 now support using pkg.* / aptpkg.* (#58395) +.IP \(bu 2 +Restoring functionallity of the textfsm module when using textfsm_path argument (#58499) +.IP \(bu 2 +Invalidate file list cache when cache file has a future last modified time (#58529) +.IP \(bu 2 +Fix issue with setting permissions in combination with the win_perms_reset +option (#58541) +.IP \(bu 2 +Adds support for Powershell 7. It is specified by passing shell="pwsh". Only +valid if Powershell 7 is installed on the system. (#58598) +.IP \(bu 2 +Fixed the zabbix.host_create call on zabbix_host.present to include the +optional parameter visible_name. Now working as documented. (#58602) +.IP \(bu 2 +Fixed some bugs to allow zabbix_host.present to update a host already +existent on Zabbix server: +.INDENT 2.0 +.IP \(bu 2 +Added checks before "pop" the elements "bulk" and "details" from +hostinterfaces_get\(aqs response. Without that, the interface comparison +didn\(aqt works with Zabbix >= 5.0 +.IP \(bu 2 +Fixed the "inventory" comparison. It failed when both current and new +inventory were missing. +.IP \(bu 2 +Rewrite of the update_interfaces routine to really "update" the +interfaces and not trying to delete and recreate all interfaces, +which almost always gives errors as interfaces with linked items +can\(aqt be deleted. (#58603) +.UNINDENT +.IP \(bu 2 +Added the "details" mandatory object with the properly default values +when creating a SNMP hostinterface in Zabbix 5.0 (#58620) +.IP \(bu 2 +Fixing an issue preventing running pillar.get against pillar values with integers as pillar keys. (#58714) +.IP \(bu 2 +Adding a new option to pass client_flags to MySQL connections, for example passing the option to support multiple statements in queries. (#58718) +.IP \(bu 2 +Fixed two performance bugs in the sysctl.present state. Their impact is +especially great on FreeBSD machines with large amounts of RAM. (#58732) +.IP \(bu 2 +Fixed an issue when pillar files are included in the \fItop.sls\fP and then later included in another pillar file. (#58736) +.IP \(bu 2 +Left over py2 code was causing windows encoding to misbehave (#58749) +.IP \(bu 2 +Return result=None from module.run state to indicate that changes would be made +Return result=False from module.run state when called with no functions (#58752) +.IP \(bu 2 +Fix duplicate IP addresses in fqdn_ip4 and fqdn_ip6 grains (#58799) +.IP \(bu 2 +Rename \fIsalt.renderers.toml\fP to \fIsalt.renderers.tomlmod\fP which fixes the import error issues as described in #58822 +Do note that, the renderer is still called \fItoml\fP\&. (#58822) +.IP \(bu 2 +Fixing unhold in yumpkg. Removing unnecessary code and relying on the code that handles dicts later. Adding tests when pkg.installed is called with hold=False. (#58883) +.IP \(bu 2 +Converts the given "grant" to upper case before compare to "ALL". +This fixes a problem granting "all privileges" to a MySQL user. (#58933) +.IP \(bu 2 +Strip trailing "/" from repo.uri when comparing repos in "apktpkg.mod_repo" (#58962) +.IP \(bu 2 +When we are checking requisites, run reconcile_procs just on those requisite states not all running states. (#58976) +.IP \(bu 2 +Allow the gpg module to use export_key, delete_key and create_key without a passphrase in GnuPG >= 2.1 (#58980) +.IP \(bu 2 +Updated the documentation, handling and error messages for what size units are allowed by "size" parameter in lvm.lv_present (#58985) +.IP \(bu 2 +Fixing the two failing tests when running on Photon OS. Python 3 installed on Photon OS does not support MD4 hashing, so don\(aqt load pdbedit module and skip the test_generate_nt_hash test. Default unmask for files and directories results in them having only user and group permissions so update the test_directory_max_depth test. (#58991) +.IP \(bu 2 +Fixes to netmiko module and proxy module to handle situations where the device is unreachable during the initial connection phase. (#59011) +.IP \(bu 2 +Correct comment when updating postrges users and groups. +Errors reported when removing postgres groups. +Partial group membership changes in postgres groups. (#59034) +.IP \(bu 2 +Fixed an error when running svn.latest in test mode and using the trust_failures +option. (#59069) +.IP \(bu 2 +Fixes to storing schedule items in pillar, when refreshing pillar only update the schedule items if something has changed. (#59104) +.IP \(bu 2 +Fixed timezone module to work in Slackware Linux (#59130) +.IP \(bu 2 +Enforces pywinrm to be version 0.3.0 or higher and upgrade to latest (#59138) +.IP \(bu 2 +Fix a race condition in the ldx module which sometimes caused devices not to be created during container creation. (#59145) +.IP \(bu 2 +Fix issue where passed smb port was being passed to the smb connection when +deploying Windows with salt\-cloud (#59153) +.IP \(bu 2 +Fixed an error when running on CentOS Stream 8. (#59161) +.IP \(bu 2 +Fix event publish retry when using TCP transport (#59162) +.IP \(bu 2 +Fix docs for \fIauth_timeout\fP (#59175) +.IP \(bu 2 +virt.update doesn\(aqt update the definition if efi=True and a loader is already set (#59188) +.IP \(bu 2 +Fixed salt.modules.solaris_shadow failing on bytes\-like object is require, not \(aqstr\(aq. (#59191) +.IP \(bu 2 +Added support for io2 volumes in ec2 cloud (#59218) +.IP \(bu 2 +When checking if the mode had changed in the file state module, only do so if the passed mode is not None. (#59276) +.IP \(bu 2 +Fixing _sanitze_comments to use sqlparse instead of re.sub. (#59336) +.IP \(bu 2 +Allow use of query parameters in cmd.script source url (#59362) +.IP \(bu 2 +Access user from global group if local group fails to find user. (#59412) +.IP \(bu 2 +Detect and fix grub.xen path (#59484) +.IP \(bu 2 +Stop raising \fIStopIteration\fP on generators (#59512) +.IP \(bu 2 +Fix minion race conditions handling SIGTERM signal when loading modules (#59524) +.IP \(bu 2 +Support new output of systemd systemctl list\-unit\-files in the following modules systemd_service.get_enabled, systemd_service.get_disabled and systemd_service.get_static (#59526) +.IP \(bu 2 +Fix pkg.upgrade with \-U arg on FreeBSD, \-L flag was deprecated long time. (#59565) +.IP \(bu 2 +Fixing the virtual function for the netimiko module to allow it to run outside of a proxy minion. Adding additional tests. (#59635) +.IP \(bu 2 +Allow "extra_filerefs" as sanitized kwargs for SSH client. +Fix regression on "cmd.run" when passing tuples as cmd. (#59664) +.UNINDENT .SS Salt 3002 Release Notes \- Codename Magnesium .SS New Features .SS Network Teaming Support Added (RHEL/CentOS) @@ -458308,9 +459814,9 @@ Prior to this change eauth was not properly validated when calling Salt ssh via the salt\-api. Any value for \(aqeauth\(aq or \(aqtoken\(aq would allow a user to bypass authentication and make calls to Salt ssh. (CVE\-2020\-25592) .UNINDENT -.SS Salt "3003" Release Notes +.SS Salt 3002.2 Release Notes .sp -Version "3003" is a bugfix release for 3002\&. +Version 3002.2 is a bugfix release for 3002\&. .SS Fixed .INDENT 0.0 .IP \(bu 2 @@ -458346,6 +459852,90 @@ Fixes salt\-ssh authentication when using tty (#58922) .IP \(bu 2 Revert LazyLoader finalizer. Removed the weakref.finalizer code. On some occasions, the finalized would run when trying to load a new module, firing a race condition. (#58947) .UNINDENT +.SS Salt 3002.3 Release Notes +.sp +Version 3002.3 is a CVE fix release for 3002\&. +.SS Fixed +.INDENT 0.0 +.IP \(bu 2 +CVE\-2020\-28243 \- Fix local privilege escalation in the restartcheck module. +.IP \(bu 2 +CVE\-2020\-28972 \- Ensure authentication to vcenter, vsphere, and esxi server +validates the SSL/TLS certificate by default. If you want to skip SSL verification +you can use \fIverify_ssl: False\fP\&. +.IP \(bu 2 +CVE\-2020\-35662 \- Ensure the asam runner, qingcloud, splunk returner, panos +proxy, cimc proxy, zenoss module, esxi module, vsphere module, glassfish +module, bigip module, and keystone module validate SSL by default. If you want +to skip SSL verification you can use \fIverify_ssl: False\fP\&. +.IP \(bu 2 +CVE\-2021\-3148 \- Fix a command injection in the Salt\-API when using the +Salt\-SSH client. +.IP \(bu 2 +CVE\-2021\-3144 \- Fix eauth tokens can be used once after expiration +.IP \(bu 2 +CVE\-2021\-25281 \- Fix salt\-api so it honors eauth credentials for the +wheel_async client. +.IP \(bu 2 +CVE\-2021\-25282 \- Fix the salt.wheel.pillar_roots.write method so it is not +vulnerable to directory traversal. +.IP \(bu 2 +CVE\-2021\-25283 \- Fix the jinja render to protect against server side template +injection attacks. +.IP \(bu 2 +CVE\-2021\-25284 \- Fix cmdmod so it will not log credentials to log levels info +and error. +.IP \(bu 2 +CVE\-2021\-3197 \- Fix ssh client to remove ProxyCommand from arguments provided +by cli and netapi. +.UNINDENT +.SS Salt 3002.4 Release Notes +.sp +Version 3002.4 is a bug fix release for 3002\&. +.SS Fixed +.INDENT 0.0 +.IP \(bu 2 +Fix runners that broke when patching for CVE\-2021\-25281 +.IP \(bu 2 +Fix issue with runners in SSE +.UNINDENT +.SS Known Issue +.sp +When using the Salt\-API with the SSH client some of the SSH options are not working currently and will be fixed in an upcoming bug fix release. +We are currently testing and fixing which options still need to be fixed, but have confirmed the following ones do not work in this release: extra\-filerefs, pre\-flight. +This does not impact normal Salt\-SSH usage on the cli. +.SS Salt 3002.5 Release Notes +.sp +Version 3002.5 is a cve fix release for 3002\&. +.SS Fixed +.INDENT 0.0 +.IP \(bu 2 +Tests and fix for CVE\-2021\-25283 +.UNINDENT +.SS Known Issue +.sp +When using the Salt\-API with the SSH client some of the SSH options are not working currently and will be fixed in an upcoming bug fix release. +We are currently testing and fixing which options still need to be fixed, but have confirmed the following ones do not work in this release: extra\-filerefs, pre\-flight. +This does not impact normal Salt\-SSH usage on the cli. +.SS Salt 3002.6 Release Notes +.sp +Version 3002.6 is a bug fix release for 3002\&. +.SS Changed +.INDENT 0.0 +.IP \(bu 2 +Store git sha in salt/_version.py when installing from a tag so it can be found if needed later. (#59137) +.UNINDENT +.SS Fixed +.INDENT 0.0 +.IP \(bu 2 +Fix argument injection bug in restartcheck.restartcheck. This change hardens +the fix for CVE\-2020\-28243. (#200) +.IP \(bu 2 +Allow "extra_filerefs" as sanitized kwargs for SSH client. +Fix regression on "cmd.run" when passing tuples as cmd. (#59664) +.IP \(bu 2 +Allow all ssh kwargs as sanitized kwargs for SSH client. (#59748) +.UNINDENT .SS Salt 3001 Release Notes \- Codename Sodium .SS Python 2 Dropped .sp @@ -458679,6 +460269,72 @@ Version 3001.4 is a bugfix release for 3001\&. .IP \(bu 2 Fixes salt\-ssh authentication when using tty (#58922) .UNINDENT +.SS Salt 3001.5 Release Notes +.sp +Version 3001.5 is a CVE fix release for 3001\&. +.SS Fixed +.INDENT 0.0 +.IP \(bu 2 +CVE\-2020\-28243 \- Fix local privilege escalation in the restartcheck module. +.IP \(bu 2 +CVE\-2020\-28972 \- Ensure authentication to vcenter, vsphere, and esxi server +validates the SSL/TLS certificate by default. If you want to skip SSL verification +you can use \fIverify_ssl: False\fP\&. +.IP \(bu 2 +CVE\-2020\-35662 \- Ensure the asam runner, qingcloud, splunk returner, panos +proxy, cimc proxy, zenoss module, esxi module, vsphere module, glassfish +module, bigip module, and keystone module validate SSL by default. If you want +to skip SSL verification you can use \fIverify_ssl: False\fP\&. +.IP \(bu 2 +CVE\-2021\-3148 \- Fix a command injection in the Salt\-API when using the +Salt\-SSH client. +.IP \(bu 2 +CVE\-2021\-3144 \- Fix eauth tokens can be used once after expiration +.IP \(bu 2 +CVE\-2021\-25281 \- Fix salt\-api so it honors eauth credentials for the +wheel_async client. +.IP \(bu 2 +CVE\-2021\-25282 \- Fix the salt.wheel.pillar_roots.write method so it is not +vulnerable to directory traversal. +.IP \(bu 2 +CVE\-2021\-25283 \- Fix the jinja render to protect against server side template +injection attacks. +.IP \(bu 2 +CVE\-2021\-25284 \- Fix cmdmod so it will not log credentials to log levels info +and error. +.IP \(bu 2 +CVE\-2021\-3197 \- Fix ssh client to remove ProxyCommand from arguments provided +by cli and netapi. +.UNINDENT +.SS Salt 3001.6 Release Notes +.sp +Version 3001.6 is a bug fix release for 3001\&. +.SS Fixed +.INDENT 0.0 +.IP \(bu 2 +Fix runners that broke when patching for CVE\-2021\-25281 +.IP \(bu 2 +Fix issue with runners in SSE +.UNINDENT +.SS Known Issue +.sp +When using the Salt\-API with the SSH client some of the SSH options are not working currently and will be fixed in an upcoming bug fix release. +We are currently testing and fixing which options still need to be fixed, but have confirmed the following ones do not work in this release: extra\-filerefs, pre\-flight. +This does not impact normal Salt\-SSH usage on the cli. +.SS Salt 3001.7 Release Notes +.sp +Version 3001.7 is a bug fix release for 3001\&. +.SS Fixed +.INDENT 0.0 +.IP \(bu 2 +Allow "extra_filerefs" as sanitized kwargs for SSH client. +Fix regression on "cmd.run" when passing tuples as cmd. (#59664) +.IP \(bu 2 +Allow all ssh kwargs as sanitized kwargs for SSH client. (#59748) +.IP \(bu 2 +Fix argument injection bug in restartcheck.restartcheck. This change hardens +the fix for CVE\-2020\-28243. +.UNINDENT .SS Salt 3000 Release Notes \- Codename Neon .SS Security Advisory .sp @@ -459604,7 +461260,7 @@ The nova cloud driver has been removed in favor of the openstack cloud driver. .SS Jinja Filter Deprecations .INDENT 0.0 .IP \(bu 2 -The following jinja filters are set to be removed in the Aluminium release: +The following jinja filters are set to be removed in the 3003 release: .INDENT 2.0 .IP \(bu 2 \fBjson_decode_dict\fP in favor of \fBtojson\fP @@ -460742,6 +462398,72 @@ Version 3000.6 is a bugfix release for 3000\&. .IP \(bu 2 Fixes salt\-ssh authentication when using tty (#58922) .UNINDENT +.SS Salt 3000.7 Release Notes +.sp +Version 3000.7 is a CVE fix release for 3000\&. +.SS Fixed +.INDENT 0.0 +.IP \(bu 2 +CVE\-2020\-28243 \- Fix local privilege escalation in the restartcheck module. +.IP \(bu 2 +CVE\-2020\-28972 \- Ensure authentication to vcenter, vsphere, and esxi server +validates the SSL/TLS certificate by default. If you want to skip SSL verification +you can use \fIverify_ssl: False\fP\&. +.IP \(bu 2 +CVE\-2020\-35662 \- Ensure the asam runner, qingcloud, splunk returner, panos +proxy, cimc proxy, zenoss module, esxi module, vsphere module, glassfish +module, bigip module, and keystone module validate SSL by default. If you want +to skip SSL verification you can use \fIverify_ssl: False\fP\&. +.IP \(bu 2 +CVE\-2021\-3148 \- Fix a command injection in the Salt\-API when using the +Salt\-SSH client. +.IP \(bu 2 +CVE\-2021\-3144 \- Fix eauth tokens can be used once after expiration +.IP \(bu 2 +CVE\-2021\-25281 \- Fix salt\-api so it honors eauth credentials for the +wheel_async client. +.IP \(bu 2 +CVE\-2021\-25282 \- Fix the salt.wheel.pillar_roots.write method so it is not +vulnerable to directory traversal. +.IP \(bu 2 +CVE\-2021\-25283 \- Fix the jinja render to protect against server side template +injection attacks. +.IP \(bu 2 +CVE\-2021\-25284 \- Fix cmdmod so it will not log credentials to log levels info +and error. +.IP \(bu 2 +CVE\-2021\-3197 \- Fix ssh client to remove ProxyCommand from arguments provided +by cli and netapi. +.UNINDENT +.SS Salt 3000.8 Release Notes +.sp +Version 3000.8 is a bug fix release for 3000\&. +.SS Fixed +.INDENT 0.0 +.IP \(bu 2 +Fix runners that broke when patching for CVE\-2021\-25281 +.IP \(bu 2 +Fix issue with runners in SSE +.UNINDENT +.SS Known Issue +.sp +When using the Salt\-API with the SSH client some of the SSH options are not working currently and will be fixed in an upcoming bug fix release. +We are currently testing and fixing which options still need to be fixed, but have confirmed the following ones do not work in this release: extra\-filerefs, pre\-flight. +This does not impact normal Salt\-SSH usage on the cli. +.SS Salt 3000.9 Release Notes +.sp +Version 3000.9 is a bug fix release for 3000\&. +.SS Fixed +.INDENT 0.0 +.IP \(bu 2 +Allow "extra_filerefs" as sanitized kwargs for SSH client. +Fix regression on "cmd.run" when passing tuples as cmd. (#59664) +.IP \(bu 2 +Allow all ssh kwargs as sanitized kwargs for SSH client. (#59748) +.IP \(bu 2 +Fix argument injection bug in restartcheck.restartcheck. This change hardens +the fix for CVE\-2020\-28243. +.UNINDENT .SS Salt 2019.2.0 Release Notes \- Codename Fluorine .SS Python 2.7 Deprecation .sp @@ -462263,7 +463985,7 @@ salt\-api provides a RESTful interface to a running Salt system. It allows for viewing minions, runners, and jobs as well as running execution modules and runners of a running Salt system through a REST API that returns JSON. See \fI\%Salt\-API\fP documentation. -\&.. _Salt\-API: \fI\%https://docs.saltstack.com/en/latest/topics/netapi/index.html\fP +.. _Salt\-API: \fI\%https://docs.saltstack.com/en/latest/topics/netapi/index.html\fP .SS Logging Changes .SS Include Job ID (JID) in Minion and Master Logs .sp @@ -580095,31 +581817,9 @@ runners and commands like salt\-key. Tests have been added to test the aspects of the client APIs and ensure that the client calls work, and that they manage passed data, in a desirable way. .SS Upcoming Release -.SS Salt 3003 Release Notes \- Codename Aluminium +.SS Salt 3004 Release Notes \- Codename Silicon .sp -Salt 3003 is an \fIunreleased\fP upcoming feature release. -.SS Execution Module Changes -.SS Changed -.INDENT 0.0 -.IP \(bu 2 -The \fBpkg\fP module now supports \fBtdnf\fP used by -VMWare Photon OS. As part of this change, \fBVMWare Photon OS\fP\(aqs -\fBos_family\fP grain will now resolve as \fBRedHat\fP\&. This may require changes -to existing uses of \fBgrains.filter_by\fP -.IP \(bu 2 -The \fBsalt\-run\fP CLI now accepts \fB\-\-jid\fP which allows scripting against it. -.UNINDENT -.SS Salt Cloud -.SS Added -.INDENT 0.0 -.IP \(bu 2 -Firewall groups support to Vultr Salt Cloud provider -.UNINDENT -.SS Fixed -.INDENT 0.0 -.IP \(bu 2 -The Google Cloud Engine salt\-cloud provider now requires \fIapache\-libcloud>=2.5.0\fP\&. Service account authentication is broken on older versions. -.UNINDENT +Salt 3004 is an \fIunreleased\fP upcoming feature release. .sp \fBSEE ALSO:\fP .INDENT 0.0 diff --git a/doc/man/spm.1 b/doc/man/spm.1 index dd49e470437..2495673de25 100644 --- a/doc/man/spm.1 +++ b/doc/man/spm.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "SPM" "1" "Feb 23, 2021" "3003" "Salt" +.TH "SPM" "1" "Apr 20, 2021" "3003.1" "Salt" .SH NAME spm \- Salt Package Manager Command . diff --git a/doc/topics/releases/3003.1.rst b/doc/topics/releases/3003.1.rst new file mode 100644 index 00000000000..5effb84e62a --- /dev/null +++ b/doc/topics/releases/3003.1.rst @@ -0,0 +1,19 @@ +.. _release-3003-1: + +========================= +Salt 3003.1 Release Notes +========================= + +Version 3003.1 is a bug fix release for :ref:`3003 `. + +Removed +======= + +- Removed support for Ubuntu 16.04 (#59913) + + +Fixed +===== + +- Import salt.utils.azurearm instead of using __utils__ from loader in azure cloud. This fixes an issue where __utils__ would become unavailable when we are using the ThreadPool in azurearm. (#59744) +- Use contextvars libary from site-packages if it is intalled. Fixes salt ssh for targets with python <=3.6 (#59942) \ No newline at end of file diff --git a/requirements/base.txt b/requirements/base.txt index 6913f4ccb80..96037ccf14c 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -4,4 +4,4 @@ PyYAML MarkupSafe requests>=1.0.0 distro>=1.0.1 -contextvars; python_version < '3.7' +contextvars diff --git a/requirements/darwin.txt b/requirements/darwin.txt index 621e50727cb..cd0c1ec16de 100644 --- a/requirements/darwin.txt +++ b/requirements/darwin.txt @@ -1,6 +1,7 @@ # Darwin source distribution requirements -r zeromq.txt +-r pyobjc.txt apache-libcloud>=2.4.0 backports.ssl_match_hostname>=3.7.0.1; python_version < '3.7' @@ -19,4 +20,3 @@ python-gnupg>=0.4.4 setproctitle>=1.1.10 timelib>=0.2.5 vultr>=1.0.1 -pyobjc==6.2.2 diff --git a/requirements/pyobjc.txt b/requirements/pyobjc.txt new file mode 100644 index 00000000000..38749223f16 --- /dev/null +++ b/requirements/pyobjc.txt @@ -0,0 +1,123 @@ +# pyobjc requirements for darwin +# This may need to be updated from time to time as new frameworks are added to +# newer releases of macOS +pyobjc==6.2.2 +pyobjc-core==6.2.2 +pyobjc-framework-AVFoundation==6.2.2 +pyobjc-framework-AVKit==6.2.2 +pyobjc-framework-Accounts==6.2.2 +pyobjc-framework-AdSupport==6.2.2 +pyobjc-framework-AddressBook==6.2.2 +pyobjc-framework-AppleScriptKit==6.2.2 +pyobjc-framework-AppleScriptObjC==6.2.2 +pyobjc-framework-ApplicationServices==6.2.2 +pyobjc-framework-AuthenticationServices==6.2.2 +pyobjc-framework-AutomaticAssessmentConfiguration==6.2.2 +pyobjc-framework-Automator==6.2.2 +pyobjc-framework-BusinessChat==6.2.2 +pyobjc-framework-CFNetwork==6.2.2 +pyobjc-framework-CalendarStore==6.2.2 +pyobjc-framework-CloudKit==6.2.2 +pyobjc-framework-Cocoa==6.2.2 +pyobjc-framework-Collaboration==6.2.2 +pyobjc-framework-ColorSync==6.2.2 +pyobjc-framework-Contacts==6.2.2 +pyobjc-framework-ContactsUI==6.2.2 +pyobjc-framework-CoreAudio==6.2.2 +pyobjc-framework-CoreAudioKit==6.2.2 +pyobjc-framework-CoreBluetooth==6.2.2 +pyobjc-framework-CoreData==6.2.2 +pyobjc-framework-CoreHaptics==6.2.2 +pyobjc-framework-CoreLocation==6.2.2 +pyobjc-framework-CoreML==6.2.2 +pyobjc-framework-CoreMedia==6.2.2 +pyobjc-framework-CoreMediaIO==6.2.2 +pyobjc-framework-CoreMotion==6.2.2 +pyobjc-framework-CoreServices==6.2.2 +pyobjc-framework-CoreSpotlight==6.2.2 +pyobjc-framework-CoreText==6.2.2 +pyobjc-framework-CoreWLAN==6.2.2 +pyobjc-framework-CryptoTokenKit==6.2.2 +pyobjc-framework-DVDPlayback==6.2.2 +pyobjc-framework-DeviceCheck==6.2.2 +pyobjc-framework-DictionaryServices==6.2.2 +pyobjc-framework-DiscRecording==6.2.2 +pyobjc-framework-DiscRecordingUI==6.2.2 +pyobjc-framework-DiskArbitration==6.2.2 +pyobjc-framework-EventKit==6.2.2 +pyobjc-framework-ExceptionHandling==6.2.2 +pyobjc-framework-ExecutionPolicy==6.2.2 +pyobjc-framework-ExternalAccessory==6.2.2 +pyobjc-framework-FSEvents==6.2.2 +pyobjc-framework-FileProvider==6.2.2 +pyobjc-framework-FileProviderUI==6.2.2 +pyobjc-framework-FinderSync==6.2.2 +pyobjc-framework-GameCenter==6.2.2 +pyobjc-framework-GameController==6.2.2 +pyobjc-framework-GameKit==6.2.2 +pyobjc-framework-GameplayKit==6.2.2 +pyobjc-framework-IMServicePlugIn==6.2.2 +pyobjc-framework-IOSurface==6.2.2 +pyobjc-framework-ImageCaptureCore==6.2.2 +pyobjc-framework-InputMethodKit==6.2.2 +pyobjc-framework-InstallerPlugins==6.2.2 +pyobjc-framework-InstantMessage==6.2.2 +pyobjc-framework-Intents==6.2.2 +pyobjc-framework-InterfaceBuilderKit==6.2.2 +pyobjc-framework-LatentSemanticMapping==6.2.2 +pyobjc-framework-LaunchServices==6.2.2 +pyobjc-framework-LinkPresentation==6.2.2 +pyobjc-framework-LocalAuthentication==6.2.2 +pyobjc-framework-MapKit==6.2.2 +pyobjc-framework-MediaAccessibility==6.2.2 +pyobjc-framework-MediaLibrary==6.2.2 +pyobjc-framework-MediaPlayer==6.2.2 +pyobjc-framework-MediaToolbox==6.2.2 +pyobjc-framework-Message==6.2.2 +pyobjc-framework-Metal==6.2.2 +pyobjc-framework-MetalKit==6.2.2 +pyobjc-framework-ModelIO==6.2.2 +pyobjc-framework-MultipeerConnectivity==6.2.2 +pyobjc-framework-NaturalLanguage==6.2.2 +pyobjc-framework-NetFS==6.2.2 +pyobjc-framework-Network==6.2.2 +pyobjc-framework-NetworkExtension==6.2.2 +pyobjc-framework-NotificationCenter==6.2.2 +pyobjc-framework-OSAKit==6.2.2 +pyobjc-framework-OSLog==6.2.2 +pyobjc-framework-OpenDirectory==6.2.2 +pyobjc-framework-PencilKit==6.2.2 +pyobjc-framework-Photos==6.2.2 +pyobjc-framework-PhotosUI==6.2.2 +pyobjc-framework-PreferencePanes==6.2.2 +pyobjc-framework-PubSub==6.2.2 +pyobjc-framework-PushKit==6.2.2 +pyobjc-framework-QTKit==6.2.2 +pyobjc-framework-Quartz==6.2.2 +pyobjc-framework-QuickLookThumbnailing==6.2.2 +pyobjc-framework-SafariServices==6.2.2 +pyobjc-framework-SceneKit==6.2.2 +pyobjc-framework-ScreenSaver==6.2.2 +pyobjc-framework-ScriptingBridge==6.2.2 +pyobjc-framework-SearchKit==6.2.2 +pyobjc-framework-Security==6.2.2 +pyobjc-framework-SecurityFoundation==6.2.2 +pyobjc-framework-SecurityInterface==6.2.2 +pyobjc-framework-ServerNotification==6.2.2 +pyobjc-framework-ServiceManagement==6.2.2 +pyobjc-framework-Social==6.2.2 +pyobjc-framework-SoundAnalysis==6.2.2 +pyobjc-framework-Speech==6.2.2 +pyobjc-framework-SpriteKit==6.2.2 +pyobjc-framework-StoreKit==6.2.2 +pyobjc-framework-SyncServices==6.2.2 +pyobjc-framework-SystemConfiguration==6.2.2 +pyobjc-framework-SystemExtensions==6.2.2 +pyobjc-framework-UserNotifications==6.2.2 +pyobjc-framework-VideoSubscriberAccount==6.2.2 +pyobjc-framework-VideoToolbox==6.2.2 +pyobjc-framework-Vision==6.2.2 +pyobjc-framework-WebKit==6.2.2 +pyobjc-framework-XgridFoundation==6.2.2 +pyobjc-framework-iTunesLibrary==6.2.2 +pyobjc-framework-libdispatch==6.2.2 diff --git a/requirements/static/ci/py3.5/darwin.txt b/requirements/static/ci/py3.5/darwin.txt index 09072f2f500..eb961c636ef 100644 --- a/requirements/static/ci/py3.5/darwin.txt +++ b/requirements/static/ci/py3.5/darwin.txt @@ -112,7 +112,7 @@ cherrypy==17.4.1 click==7.0 # via geomet clustershell==1.8.1 contextlib2==0.6.0.post1 -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.0 decorator==4.4.2 # via networkx @@ -233,3 +233,122 @@ zc.lockfile==2.0 zipp==0.6.0 # via importlib-metadata, importlib-resources, moto # Passthrough dependencies from requirements/static/pkg/py3.5/darwin.txt pyobjc==6.2.2 +pyobjc-core==6.2.2 +pyobjc-framework-AVFoundation==6.2.2 +pyobjc-framework-AVKit==6.2.2 +pyobjc-framework-Accounts==6.2.2 +pyobjc-framework-AdSupport==6.2.2 +pyobjc-framework-AddressBook==6.2.2 +pyobjc-framework-AppleScriptKit==6.2.2 +pyobjc-framework-AppleScriptObjC==6.2.2 +pyobjc-framework-ApplicationServices==6.2.2 +pyobjc-framework-AuthenticationServices==6.2.2 +pyobjc-framework-AutomaticAssessmentConfiguration==6.2.2 +pyobjc-framework-Automator==6.2.2 +pyobjc-framework-BusinessChat==6.2.2 +pyobjc-framework-CFNetwork==6.2.2 +pyobjc-framework-CalendarStore==6.2.2 +pyobjc-framework-CloudKit==6.2.2 +pyobjc-framework-Cocoa==6.2.2 +pyobjc-framework-Collaboration==6.2.2 +pyobjc-framework-ColorSync==6.2.2 +pyobjc-framework-Contacts==6.2.2 +pyobjc-framework-ContactsUI==6.2.2 +pyobjc-framework-CoreAudio==6.2.2 +pyobjc-framework-CoreAudioKit==6.2.2 +pyobjc-framework-CoreBluetooth==6.2.2 +pyobjc-framework-CoreData==6.2.2 +pyobjc-framework-CoreHaptics==6.2.2 +pyobjc-framework-CoreLocation==6.2.2 +pyobjc-framework-CoreML==6.2.2 +pyobjc-framework-CoreMedia==6.2.2 +pyobjc-framework-CoreMediaIO==6.2.2 +pyobjc-framework-CoreMotion==6.2.2 +pyobjc-framework-CoreServices==6.2.2 +pyobjc-framework-CoreSpotlight==6.2.2 +pyobjc-framework-CoreText==6.2.2 +pyobjc-framework-CoreWLAN==6.2.2 +pyobjc-framework-CryptoTokenKit==6.2.2 +pyobjc-framework-DVDPlayback==6.2.2 +pyobjc-framework-DeviceCheck==6.2.2 +pyobjc-framework-DictionaryServices==6.2.2 +pyobjc-framework-DiscRecording==6.2.2 +pyobjc-framework-DiscRecordingUI==6.2.2 +pyobjc-framework-DiskArbitration==6.2.2 +pyobjc-framework-EventKit==6.2.2 +pyobjc-framework-ExceptionHandling==6.2.2 +pyobjc-framework-ExecutionPolicy==6.2.2 +pyobjc-framework-ExternalAccessory==6.2.2 +pyobjc-framework-FSEvents==6.2.2 +pyobjc-framework-FileProvider==6.2.2 +pyobjc-framework-FileProviderUI==6.2.2 +pyobjc-framework-FinderSync==6.2.2 +pyobjc-framework-GameCenter==6.2.2 +pyobjc-framework-GameController==6.2.2 +pyobjc-framework-GameKit==6.2.2 +pyobjc-framework-GameplayKit==6.2.2 +pyobjc-framework-IMServicePlugIn==6.2.2 +pyobjc-framework-IOSurface==6.2.2 +pyobjc-framework-ImageCaptureCore==6.2.2 +pyobjc-framework-InputMethodKit==6.2.2 +pyobjc-framework-InstallerPlugins==6.2.2 +pyobjc-framework-InstantMessage==6.2.2 +pyobjc-framework-Intents==6.2.2 +pyobjc-framework-InterfaceBuilderKit==6.2.2 +pyobjc-framework-LatentSemanticMapping==6.2.2 +pyobjc-framework-LaunchServices==6.2.2 +pyobjc-framework-LinkPresentation==6.2.2 +pyobjc-framework-LocalAuthentication==6.2.2 +pyobjc-framework-MapKit==6.2.2 +pyobjc-framework-MediaAccessibility==6.2.2 +pyobjc-framework-MediaLibrary==6.2.2 +pyobjc-framework-MediaPlayer==6.2.2 +pyobjc-framework-MediaToolbox==6.2.2 +pyobjc-framework-Message==6.2.2 +pyobjc-framework-Metal==6.2.2 +pyobjc-framework-MetalKit==6.2.2 +pyobjc-framework-ModelIO==6.2.2 +pyobjc-framework-MultipeerConnectivity==6.2.2 +pyobjc-framework-NaturalLanguage==6.2.2 +pyobjc-framework-NetFS==6.2.2 +pyobjc-framework-Network==6.2.2 +pyobjc-framework-NetworkExtension==6.2.2 +pyobjc-framework-NotificationCenter==6.2.2 +pyobjc-framework-OSAKit==6.2.2 +pyobjc-framework-OSLog==6.2.2 +pyobjc-framework-OpenDirectory==6.2.2 +pyobjc-framework-PencilKit==6.2.2 +pyobjc-framework-Photos==6.2.2 +pyobjc-framework-PhotosUI==6.2.2 +pyobjc-framework-PreferencePanes==6.2.2 +pyobjc-framework-PubSub==6.2.2 +pyobjc-framework-PushKit==6.2.2 +pyobjc-framework-QTKit==6.2.2 +pyobjc-framework-Quartz==6.2.2 +pyobjc-framework-QuickLookThumbnailing==6.2.2 +pyobjc-framework-SafariServices==6.2.2 +pyobjc-framework-SceneKit==6.2.2 +pyobjc-framework-ScreenSaver==6.2.2 +pyobjc-framework-ScriptingBridge==6.2.2 +pyobjc-framework-SearchKit==6.2.2 +pyobjc-framework-Security==6.2.2 +pyobjc-framework-SecurityFoundation==6.2.2 +pyobjc-framework-SecurityInterface==6.2.2 +pyobjc-framework-ServerNotification==6.2.2 +pyobjc-framework-ServiceManagement==6.2.2 +pyobjc-framework-Social==6.2.2 +pyobjc-framework-SoundAnalysis==6.2.2 +pyobjc-framework-Speech==6.2.2 +pyobjc-framework-SpriteKit==6.2.2 +pyobjc-framework-StoreKit==6.2.2 +pyobjc-framework-SyncServices==6.2.2 +pyobjc-framework-SystemConfiguration==6.2.2 +pyobjc-framework-SystemExtensions==6.2.2 +pyobjc-framework-UserNotifications==6.2.2 +pyobjc-framework-VideoSubscriberAccount==6.2.2 +pyobjc-framework-VideoToolbox==6.2.2 +pyobjc-framework-Vision==6.2.2 +pyobjc-framework-WebKit==6.2.2 +pyobjc-framework-XgridFoundation==6.2.2 +pyobjc-framework-iTunesLibrary==6.2.2 +pyobjc-framework-libdispatch==6.2.2 diff --git a/requirements/static/ci/py3.5/docs.txt b/requirements/static/ci/py3.5/docs.txt index f1d65f6beb1..cad2b173dda 100644 --- a/requirements/static/ci/py3.5/docs.txt +++ b/requirements/static/ci/py3.5/docs.txt @@ -14,7 +14,7 @@ chardet==3.0.4 cheroot==6.5.4 cherrypy==17.4.1 contextlib2==0.5.5 -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 cryptography==3.0 distro==1.5.0 docutils==0.16 # via sphinx diff --git a/requirements/static/ci/py3.5/freebsd.txt b/requirements/static/ci/py3.5/freebsd.txt index 658bba50b5a..53c7bc59ac3 100644 --- a/requirements/static/ci/py3.5/freebsd.txt +++ b/requirements/static/ci/py3.5/freebsd.txt @@ -114,7 +114,7 @@ cherrypy==17.4.1 click==7.1.2 # via geomet clustershell==1.8.3 contextlib2==0.5.5 -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.0 decorator==4.4.2 # via networkx diff --git a/requirements/static/ci/py3.5/linux.log b/requirements/static/ci/py3.5/linux.log deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/requirements/static/ci/py3.5/linux.txt b/requirements/static/ci/py3.5/linux.txt index 36df1e8cce2..1231675bf09 100644 --- a/requirements/static/ci/py3.5/linux.txt +++ b/requirements/static/ci/py3.5/linux.txt @@ -115,7 +115,7 @@ cherrypy==17.4.1 click==7.1.1 # via geomet clustershell==1.8.3 contextlib2==0.5.5 -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.0 decorator==4.4.2 # via networkx diff --git a/requirements/static/ci/py3.6/darwin.txt b/requirements/static/ci/py3.6/darwin.txt index 40ccd17f943..c0cf918d8ab 100644 --- a/requirements/static/ci/py3.6/darwin.txt +++ b/requirements/static/ci/py3.6/darwin.txt @@ -112,7 +112,7 @@ cherrypy==17.4.1 click==7.0 # via geomet clustershell==1.8.1 contextlib2==0.6.0.post1 -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.3.2 decorator==4.4.2 # via networkx @@ -232,3 +232,122 @@ zc.lockfile==2.0 zipp==0.6.0 # via importlib-metadata, importlib-resources, moto # Passthrough dependencies from requirements/static/pkg/py3.6/darwin.txt pyobjc==6.2.2 +pyobjc-core==6.2.2 +pyobjc-framework-AVFoundation==6.2.2 +pyobjc-framework-AVKit==6.2.2 +pyobjc-framework-Accounts==6.2.2 +pyobjc-framework-AdSupport==6.2.2 +pyobjc-framework-AddressBook==6.2.2 +pyobjc-framework-AppleScriptKit==6.2.2 +pyobjc-framework-AppleScriptObjC==6.2.2 +pyobjc-framework-ApplicationServices==6.2.2 +pyobjc-framework-AuthenticationServices==6.2.2 +pyobjc-framework-AutomaticAssessmentConfiguration==6.2.2 +pyobjc-framework-Automator==6.2.2 +pyobjc-framework-BusinessChat==6.2.2 +pyobjc-framework-CFNetwork==6.2.2 +pyobjc-framework-CalendarStore==6.2.2 +pyobjc-framework-CloudKit==6.2.2 +pyobjc-framework-Cocoa==6.2.2 +pyobjc-framework-Collaboration==6.2.2 +pyobjc-framework-ColorSync==6.2.2 +pyobjc-framework-Contacts==6.2.2 +pyobjc-framework-ContactsUI==6.2.2 +pyobjc-framework-CoreAudio==6.2.2 +pyobjc-framework-CoreAudioKit==6.2.2 +pyobjc-framework-CoreBluetooth==6.2.2 +pyobjc-framework-CoreData==6.2.2 +pyobjc-framework-CoreHaptics==6.2.2 +pyobjc-framework-CoreLocation==6.2.2 +pyobjc-framework-CoreML==6.2.2 +pyobjc-framework-CoreMedia==6.2.2 +pyobjc-framework-CoreMediaIO==6.2.2 +pyobjc-framework-CoreMotion==6.2.2 +pyobjc-framework-CoreServices==6.2.2 +pyobjc-framework-CoreSpotlight==6.2.2 +pyobjc-framework-CoreText==6.2.2 +pyobjc-framework-CoreWLAN==6.2.2 +pyobjc-framework-CryptoTokenKit==6.2.2 +pyobjc-framework-DVDPlayback==6.2.2 +pyobjc-framework-DeviceCheck==6.2.2 +pyobjc-framework-DictionaryServices==6.2.2 +pyobjc-framework-DiscRecording==6.2.2 +pyobjc-framework-DiscRecordingUI==6.2.2 +pyobjc-framework-DiskArbitration==6.2.2 +pyobjc-framework-EventKit==6.2.2 +pyobjc-framework-ExceptionHandling==6.2.2 +pyobjc-framework-ExecutionPolicy==6.2.2 +pyobjc-framework-ExternalAccessory==6.2.2 +pyobjc-framework-FSEvents==6.2.2 +pyobjc-framework-FileProvider==6.2.2 +pyobjc-framework-FileProviderUI==6.2.2 +pyobjc-framework-FinderSync==6.2.2 +pyobjc-framework-GameCenter==6.2.2 +pyobjc-framework-GameController==6.2.2 +pyobjc-framework-GameKit==6.2.2 +pyobjc-framework-GameplayKit==6.2.2 +pyobjc-framework-IMServicePlugIn==6.2.2 +pyobjc-framework-IOSurface==6.2.2 +pyobjc-framework-ImageCaptureCore==6.2.2 +pyobjc-framework-InputMethodKit==6.2.2 +pyobjc-framework-InstallerPlugins==6.2.2 +pyobjc-framework-InstantMessage==6.2.2 +pyobjc-framework-Intents==6.2.2 +pyobjc-framework-InterfaceBuilderKit==6.2.2 +pyobjc-framework-LatentSemanticMapping==6.2.2 +pyobjc-framework-LaunchServices==6.2.2 +pyobjc-framework-LinkPresentation==6.2.2 +pyobjc-framework-LocalAuthentication==6.2.2 +pyobjc-framework-MapKit==6.2.2 +pyobjc-framework-MediaAccessibility==6.2.2 +pyobjc-framework-MediaLibrary==6.2.2 +pyobjc-framework-MediaPlayer==6.2.2 +pyobjc-framework-MediaToolbox==6.2.2 +pyobjc-framework-Message==6.2.2 +pyobjc-framework-Metal==6.2.2 +pyobjc-framework-MetalKit==6.2.2 +pyobjc-framework-ModelIO==6.2.2 +pyobjc-framework-MultipeerConnectivity==6.2.2 +pyobjc-framework-NaturalLanguage==6.2.2 +pyobjc-framework-NetFS==6.2.2 +pyobjc-framework-Network==6.2.2 +pyobjc-framework-NetworkExtension==6.2.2 +pyobjc-framework-NotificationCenter==6.2.2 +pyobjc-framework-OSAKit==6.2.2 +pyobjc-framework-OSLog==6.2.2 +pyobjc-framework-OpenDirectory==6.2.2 +pyobjc-framework-PencilKit==6.2.2 +pyobjc-framework-Photos==6.2.2 +pyobjc-framework-PhotosUI==6.2.2 +pyobjc-framework-PreferencePanes==6.2.2 +pyobjc-framework-PubSub==6.2.2 +pyobjc-framework-PushKit==6.2.2 +pyobjc-framework-QTKit==6.2.2 +pyobjc-framework-Quartz==6.2.2 +pyobjc-framework-QuickLookThumbnailing==6.2.2 +pyobjc-framework-SafariServices==6.2.2 +pyobjc-framework-SceneKit==6.2.2 +pyobjc-framework-ScreenSaver==6.2.2 +pyobjc-framework-ScriptingBridge==6.2.2 +pyobjc-framework-SearchKit==6.2.2 +pyobjc-framework-Security==6.2.2 +pyobjc-framework-SecurityFoundation==6.2.2 +pyobjc-framework-SecurityInterface==6.2.2 +pyobjc-framework-ServerNotification==6.2.2 +pyobjc-framework-ServiceManagement==6.2.2 +pyobjc-framework-Social==6.2.2 +pyobjc-framework-SoundAnalysis==6.2.2 +pyobjc-framework-Speech==6.2.2 +pyobjc-framework-SpriteKit==6.2.2 +pyobjc-framework-StoreKit==6.2.2 +pyobjc-framework-SyncServices==6.2.2 +pyobjc-framework-SystemConfiguration==6.2.2 +pyobjc-framework-SystemExtensions==6.2.2 +pyobjc-framework-UserNotifications==6.2.2 +pyobjc-framework-VideoSubscriberAccount==6.2.2 +pyobjc-framework-VideoToolbox==6.2.2 +pyobjc-framework-Vision==6.2.2 +pyobjc-framework-WebKit==6.2.2 +pyobjc-framework-XgridFoundation==6.2.2 +pyobjc-framework-iTunesLibrary==6.2.2 +pyobjc-framework-libdispatch==6.2.2 diff --git a/requirements/static/ci/py3.6/docs.txt b/requirements/static/ci/py3.6/docs.txt index c8b6beb5b09..0b153a542fb 100644 --- a/requirements/static/ci/py3.6/docs.txt +++ b/requirements/static/ci/py3.6/docs.txt @@ -14,7 +14,7 @@ chardet==3.0.4 cheroot==6.5.4 cherrypy==17.4.1 contextlib2==0.5.5 -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 cryptography==3.3.2 distro==1.5.0 docutils==0.16 # via sphinx diff --git a/requirements/static/ci/py3.6/freebsd.txt b/requirements/static/ci/py3.6/freebsd.txt index 0010f492bd9..f1c2899ea51 100644 --- a/requirements/static/ci/py3.6/freebsd.txt +++ b/requirements/static/ci/py3.6/freebsd.txt @@ -114,7 +114,7 @@ cherrypy==17.4.1 click==7.1.2 # via geomet clustershell==1.8.3 contextlib2==0.5.5 -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.3.2 decorator==4.4.2 # via networkx diff --git a/requirements/static/ci/py3.6/linux.log b/requirements/static/ci/py3.6/linux.log deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/requirements/static/ci/py3.6/linux.txt b/requirements/static/ci/py3.6/linux.txt index 762a828a3b4..06d7f4b81e7 100644 --- a/requirements/static/ci/py3.6/linux.txt +++ b/requirements/static/ci/py3.6/linux.txt @@ -115,7 +115,7 @@ cherrypy==17.4.1 click==7.1.1 # via geomet clustershell==1.8.3 contextlib2==0.5.5 -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.3.2 decorator==4.4.2 # via networkx diff --git a/requirements/static/ci/py3.6/windows.txt b/requirements/static/ci/py3.6/windows.txt index 95fbafee222..b9b727b025c 100644 --- a/requirements/static/ci/py3.6/windows.txt +++ b/requirements/static/ci/py3.6/windows.txt @@ -25,7 +25,7 @@ cherrypy==18.6.0 click==7.1.2 # via geomet clustershell==1.8.3 colorama==0.4.1 # via pytest -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 cryptography==3.4.6 decorator==4.4.2 # via networkx distlib==0.3.0 # via virtualenv diff --git a/requirements/static/ci/py3.7/darwin.txt b/requirements/static/ci/py3.7/darwin.txt index a7ea78a2c40..f0b03767c55 100644 --- a/requirements/static/ci/py3.7/darwin.txt +++ b/requirements/static/ci/py3.7/darwin.txt @@ -113,6 +113,7 @@ click==7.0 # via geomet clustershell==1.8.1 colorama==0.4.3 # via ciscoconfparse contextlib2==0.6.0.post1 +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.3.2 decorator==4.4.2 # via networkx @@ -132,6 +133,7 @@ gitdb==4.0.5 gitpython==3.1.12 google-auth==1.6.3 # via kubernetes idna==2.8 +immutables==0.15 importlib-metadata==0.23 # via jsonschema, pluggy, pytest, virtualenv iniconfig==1.0.1 # via pytest ipaddress==1.0.22 # via kubernetes @@ -233,3 +235,122 @@ zc.lockfile==2.0 zipp==0.6.0 # via importlib-metadata, moto # Passthrough dependencies from requirements/static/pkg/py3.7/darwin.txt pyobjc==6.2.2 +pyobjc-core==6.2.2 +pyobjc-framework-AVFoundation==6.2.2 +pyobjc-framework-AVKit==6.2.2 +pyobjc-framework-Accounts==6.2.2 +pyobjc-framework-AdSupport==6.2.2 +pyobjc-framework-AddressBook==6.2.2 +pyobjc-framework-AppleScriptKit==6.2.2 +pyobjc-framework-AppleScriptObjC==6.2.2 +pyobjc-framework-ApplicationServices==6.2.2 +pyobjc-framework-AuthenticationServices==6.2.2 +pyobjc-framework-AutomaticAssessmentConfiguration==6.2.2 +pyobjc-framework-Automator==6.2.2 +pyobjc-framework-BusinessChat==6.2.2 +pyobjc-framework-CFNetwork==6.2.2 +pyobjc-framework-CalendarStore==6.2.2 +pyobjc-framework-CloudKit==6.2.2 +pyobjc-framework-Cocoa==6.2.2 +pyobjc-framework-Collaboration==6.2.2 +pyobjc-framework-ColorSync==6.2.2 +pyobjc-framework-Contacts==6.2.2 +pyobjc-framework-ContactsUI==6.2.2 +pyobjc-framework-CoreAudio==6.2.2 +pyobjc-framework-CoreAudioKit==6.2.2 +pyobjc-framework-CoreBluetooth==6.2.2 +pyobjc-framework-CoreData==6.2.2 +pyobjc-framework-CoreHaptics==6.2.2 +pyobjc-framework-CoreLocation==6.2.2 +pyobjc-framework-CoreML==6.2.2 +pyobjc-framework-CoreMedia==6.2.2 +pyobjc-framework-CoreMediaIO==6.2.2 +pyobjc-framework-CoreMotion==6.2.2 +pyobjc-framework-CoreServices==6.2.2 +pyobjc-framework-CoreSpotlight==6.2.2 +pyobjc-framework-CoreText==6.2.2 +pyobjc-framework-CoreWLAN==6.2.2 +pyobjc-framework-CryptoTokenKit==6.2.2 +pyobjc-framework-DVDPlayback==6.2.2 +pyobjc-framework-DeviceCheck==6.2.2 +pyobjc-framework-DictionaryServices==6.2.2 +pyobjc-framework-DiscRecording==6.2.2 +pyobjc-framework-DiscRecordingUI==6.2.2 +pyobjc-framework-DiskArbitration==6.2.2 +pyobjc-framework-EventKit==6.2.2 +pyobjc-framework-ExceptionHandling==6.2.2 +pyobjc-framework-ExecutionPolicy==6.2.2 +pyobjc-framework-ExternalAccessory==6.2.2 +pyobjc-framework-FSEvents==6.2.2 +pyobjc-framework-FileProvider==6.2.2 +pyobjc-framework-FileProviderUI==6.2.2 +pyobjc-framework-FinderSync==6.2.2 +pyobjc-framework-GameCenter==6.2.2 +pyobjc-framework-GameController==6.2.2 +pyobjc-framework-GameKit==6.2.2 +pyobjc-framework-GameplayKit==6.2.2 +pyobjc-framework-IMServicePlugIn==6.2.2 +pyobjc-framework-IOSurface==6.2.2 +pyobjc-framework-ImageCaptureCore==6.2.2 +pyobjc-framework-InputMethodKit==6.2.2 +pyobjc-framework-InstallerPlugins==6.2.2 +pyobjc-framework-InstantMessage==6.2.2 +pyobjc-framework-Intents==6.2.2 +pyobjc-framework-InterfaceBuilderKit==6.2.2 +pyobjc-framework-LatentSemanticMapping==6.2.2 +pyobjc-framework-LaunchServices==6.2.2 +pyobjc-framework-LinkPresentation==6.2.2 +pyobjc-framework-LocalAuthentication==6.2.2 +pyobjc-framework-MapKit==6.2.2 +pyobjc-framework-MediaAccessibility==6.2.2 +pyobjc-framework-MediaLibrary==6.2.2 +pyobjc-framework-MediaPlayer==6.2.2 +pyobjc-framework-MediaToolbox==6.2.2 +pyobjc-framework-Message==6.2.2 +pyobjc-framework-Metal==6.2.2 +pyobjc-framework-MetalKit==6.2.2 +pyobjc-framework-ModelIO==6.2.2 +pyobjc-framework-MultipeerConnectivity==6.2.2 +pyobjc-framework-NaturalLanguage==6.2.2 +pyobjc-framework-NetFS==6.2.2 +pyobjc-framework-Network==6.2.2 +pyobjc-framework-NetworkExtension==6.2.2 +pyobjc-framework-NotificationCenter==6.2.2 +pyobjc-framework-OSAKit==6.2.2 +pyobjc-framework-OSLog==6.2.2 +pyobjc-framework-OpenDirectory==6.2.2 +pyobjc-framework-PencilKit==6.2.2 +pyobjc-framework-Photos==6.2.2 +pyobjc-framework-PhotosUI==6.2.2 +pyobjc-framework-PreferencePanes==6.2.2 +pyobjc-framework-PubSub==6.2.2 +pyobjc-framework-PushKit==6.2.2 +pyobjc-framework-QTKit==6.2.2 +pyobjc-framework-Quartz==6.2.2 +pyobjc-framework-QuickLookThumbnailing==6.2.2 +pyobjc-framework-SafariServices==6.2.2 +pyobjc-framework-SceneKit==6.2.2 +pyobjc-framework-ScreenSaver==6.2.2 +pyobjc-framework-ScriptingBridge==6.2.2 +pyobjc-framework-SearchKit==6.2.2 +pyobjc-framework-Security==6.2.2 +pyobjc-framework-SecurityFoundation==6.2.2 +pyobjc-framework-SecurityInterface==6.2.2 +pyobjc-framework-ServerNotification==6.2.2 +pyobjc-framework-ServiceManagement==6.2.2 +pyobjc-framework-Social==6.2.2 +pyobjc-framework-SoundAnalysis==6.2.2 +pyobjc-framework-Speech==6.2.2 +pyobjc-framework-SpriteKit==6.2.2 +pyobjc-framework-StoreKit==6.2.2 +pyobjc-framework-SyncServices==6.2.2 +pyobjc-framework-SystemConfiguration==6.2.2 +pyobjc-framework-SystemExtensions==6.2.2 +pyobjc-framework-UserNotifications==6.2.2 +pyobjc-framework-VideoSubscriberAccount==6.2.2 +pyobjc-framework-VideoToolbox==6.2.2 +pyobjc-framework-Vision==6.2.2 +pyobjc-framework-WebKit==6.2.2 +pyobjc-framework-XgridFoundation==6.2.2 +pyobjc-framework-iTunesLibrary==6.2.2 +pyobjc-framework-libdispatch==6.2.2 diff --git a/requirements/static/ci/py3.7/docs.txt b/requirements/static/ci/py3.7/docs.txt index 9d79d13f100..22b175e73de 100644 --- a/requirements/static/ci/py3.7/docs.txt +++ b/requirements/static/ci/py3.7/docs.txt @@ -13,11 +13,13 @@ chardet==3.0.4 cheroot==6.5.4 cherrypy==17.4.1 contextlib2==0.5.5 +contextvars==2.4 cryptography==3.3.2 distro==1.5.0 docutils==0.16 # via sphinx idna==2.8 imagesize==1.2.0 # via sphinx +immutables==0.15 jaraco.functools==2.0 jinja2==2.10.1 markupsafe==1.1.1 diff --git a/requirements/static/ci/py3.7/freebsd.txt b/requirements/static/ci/py3.7/freebsd.txt index 13508c259c5..c36abb8247c 100644 --- a/requirements/static/ci/py3.7/freebsd.txt +++ b/requirements/static/ci/py3.7/freebsd.txt @@ -115,6 +115,7 @@ click==7.1.2 # via geomet clustershell==1.8.3 colorama==0.4.3 # via ciscoconfparse contextlib2==0.5.5 +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.3.2 decorator==4.4.2 # via networkx @@ -134,6 +135,7 @@ gitdb==4.0.5 # via gitpython gitpython==3.1.12 google-auth==1.6.3 # via kubernetes idna==2.8 +immutables==0.15 importlib-metadata==0.23 # via jsonschema, pluggy, pytest, virtualenv iniconfig==1.0.1 # via pytest ipaddress==1.0.22 # via kubernetes diff --git a/requirements/static/ci/py3.7/linux.txt b/requirements/static/ci/py3.7/linux.txt index 4ab4111e33a..82009cc34df 100644 --- a/requirements/static/ci/py3.7/linux.txt +++ b/requirements/static/ci/py3.7/linux.txt @@ -116,6 +116,7 @@ click==7.1.1 # via geomet clustershell==1.8.3 colorama==0.4.3 # via ciscoconfparse contextlib2==0.5.5 +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.3.2 decorator==4.4.2 # via networkx @@ -135,6 +136,7 @@ gitdb==4.0.5 # via gitpython gitpython==3.1.12 google-auth==1.6.3 # via kubernetes idna==2.8 +immutables==0.15 importlib-metadata==0.23 # via jsonschema, pluggy, pytest, virtualenv iniconfig==1.0.1 # via pytest ipaddress==1.0.22 # via kubernetes diff --git a/requirements/static/ci/py3.7/windows.txt b/requirements/static/ci/py3.7/windows.txt index b4f60517567..02e9a05d169 100644 --- a/requirements/static/ci/py3.7/windows.txt +++ b/requirements/static/ci/py3.7/windows.txt @@ -24,6 +24,7 @@ cherrypy==18.6.0 click==7.1.2 # via geomet clustershell==1.8.3 colorama==0.4.1 # via pytest +contextvars==2.4 cryptography==3.4.6 decorator==4.4.2 # via networkx distlib==0.3.0 # via virtualenv @@ -42,6 +43,7 @@ gitdb==4.0.5 gitpython==3.1.13 google-auth==1.6.3 # via kubernetes idna==2.8 +immutables==0.15 importlib-metadata==0.23 # via jsonschema, pluggy, pytest, virtualenv iniconfig==1.0.1 # via pytest ioloop==0.1a0 diff --git a/requirements/static/ci/py3.8/darwin.txt b/requirements/static/ci/py3.8/darwin.txt index 30a6f288e4a..f374cc6e4fc 100644 --- a/requirements/static/ci/py3.8/darwin.txt +++ b/requirements/static/ci/py3.8/darwin.txt @@ -113,6 +113,7 @@ click==7.0 # via geomet clustershell==1.8.1 colorama==0.4.3 # via ciscoconfparse contextlib2==0.6.0.post1 +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.3.2 decorator==4.4.2 # via networkx @@ -132,6 +133,7 @@ gitdb==4.0.5 gitpython==3.1.12 google-auth==1.6.3 # via kubernetes idna==2.8 +immutables==0.15 iniconfig==1.0.1 # via pytest ipaddress==1.0.22 # via kubernetes isodate==0.6.0 # via msrest @@ -232,3 +234,122 @@ zc.lockfile==2.0 zipp==3.4.0 # via moto # Passthrough dependencies from requirements/static/pkg/py3.8/darwin.txt pyobjc==6.2.2 +pyobjc-core==6.2.2 +pyobjc-framework-AVFoundation==6.2.2 +pyobjc-framework-AVKit==6.2.2 +pyobjc-framework-Accounts==6.2.2 +pyobjc-framework-AdSupport==6.2.2 +pyobjc-framework-AddressBook==6.2.2 +pyobjc-framework-AppleScriptKit==6.2.2 +pyobjc-framework-AppleScriptObjC==6.2.2 +pyobjc-framework-ApplicationServices==6.2.2 +pyobjc-framework-AuthenticationServices==6.2.2 +pyobjc-framework-AutomaticAssessmentConfiguration==6.2.2 +pyobjc-framework-Automator==6.2.2 +pyobjc-framework-BusinessChat==6.2.2 +pyobjc-framework-CFNetwork==6.2.2 +pyobjc-framework-CalendarStore==6.2.2 +pyobjc-framework-CloudKit==6.2.2 +pyobjc-framework-Cocoa==6.2.2 +pyobjc-framework-Collaboration==6.2.2 +pyobjc-framework-ColorSync==6.2.2 +pyobjc-framework-Contacts==6.2.2 +pyobjc-framework-ContactsUI==6.2.2 +pyobjc-framework-CoreAudio==6.2.2 +pyobjc-framework-CoreAudioKit==6.2.2 +pyobjc-framework-CoreBluetooth==6.2.2 +pyobjc-framework-CoreData==6.2.2 +pyobjc-framework-CoreHaptics==6.2.2 +pyobjc-framework-CoreLocation==6.2.2 +pyobjc-framework-CoreML==6.2.2 +pyobjc-framework-CoreMedia==6.2.2 +pyobjc-framework-CoreMediaIO==6.2.2 +pyobjc-framework-CoreMotion==6.2.2 +pyobjc-framework-CoreServices==6.2.2 +pyobjc-framework-CoreSpotlight==6.2.2 +pyobjc-framework-CoreText==6.2.2 +pyobjc-framework-CoreWLAN==6.2.2 +pyobjc-framework-CryptoTokenKit==6.2.2 +pyobjc-framework-DVDPlayback==6.2.2 +pyobjc-framework-DeviceCheck==6.2.2 +pyobjc-framework-DictionaryServices==6.2.2 +pyobjc-framework-DiscRecording==6.2.2 +pyobjc-framework-DiscRecordingUI==6.2.2 +pyobjc-framework-DiskArbitration==6.2.2 +pyobjc-framework-EventKit==6.2.2 +pyobjc-framework-ExceptionHandling==6.2.2 +pyobjc-framework-ExecutionPolicy==6.2.2 +pyobjc-framework-ExternalAccessory==6.2.2 +pyobjc-framework-FSEvents==6.2.2 +pyobjc-framework-FileProvider==6.2.2 +pyobjc-framework-FileProviderUI==6.2.2 +pyobjc-framework-FinderSync==6.2.2 +pyobjc-framework-GameCenter==6.2.2 +pyobjc-framework-GameController==6.2.2 +pyobjc-framework-GameKit==6.2.2 +pyobjc-framework-GameplayKit==6.2.2 +pyobjc-framework-IMServicePlugIn==6.2.2 +pyobjc-framework-IOSurface==6.2.2 +pyobjc-framework-ImageCaptureCore==6.2.2 +pyobjc-framework-InputMethodKit==6.2.2 +pyobjc-framework-InstallerPlugins==6.2.2 +pyobjc-framework-InstantMessage==6.2.2 +pyobjc-framework-Intents==6.2.2 +pyobjc-framework-InterfaceBuilderKit==6.2.2 +pyobjc-framework-LatentSemanticMapping==6.2.2 +pyobjc-framework-LaunchServices==6.2.2 +pyobjc-framework-LinkPresentation==6.2.2 +pyobjc-framework-LocalAuthentication==6.2.2 +pyobjc-framework-MapKit==6.2.2 +pyobjc-framework-MediaAccessibility==6.2.2 +pyobjc-framework-MediaLibrary==6.2.2 +pyobjc-framework-MediaPlayer==6.2.2 +pyobjc-framework-MediaToolbox==6.2.2 +pyobjc-framework-Message==6.2.2 +pyobjc-framework-Metal==6.2.2 +pyobjc-framework-MetalKit==6.2.2 +pyobjc-framework-ModelIO==6.2.2 +pyobjc-framework-MultipeerConnectivity==6.2.2 +pyobjc-framework-NaturalLanguage==6.2.2 +pyobjc-framework-NetFS==6.2.2 +pyobjc-framework-Network==6.2.2 +pyobjc-framework-NetworkExtension==6.2.2 +pyobjc-framework-NotificationCenter==6.2.2 +pyobjc-framework-OSAKit==6.2.2 +pyobjc-framework-OSLog==6.2.2 +pyobjc-framework-OpenDirectory==6.2.2 +pyobjc-framework-PencilKit==6.2.2 +pyobjc-framework-Photos==6.2.2 +pyobjc-framework-PhotosUI==6.2.2 +pyobjc-framework-PreferencePanes==6.2.2 +pyobjc-framework-PubSub==6.2.2 +pyobjc-framework-PushKit==6.2.2 +pyobjc-framework-QTKit==6.2.2 +pyobjc-framework-Quartz==6.2.2 +pyobjc-framework-QuickLookThumbnailing==6.2.2 +pyobjc-framework-SafariServices==6.2.2 +pyobjc-framework-SceneKit==6.2.2 +pyobjc-framework-ScreenSaver==6.2.2 +pyobjc-framework-ScriptingBridge==6.2.2 +pyobjc-framework-SearchKit==6.2.2 +pyobjc-framework-Security==6.2.2 +pyobjc-framework-SecurityFoundation==6.2.2 +pyobjc-framework-SecurityInterface==6.2.2 +pyobjc-framework-ServerNotification==6.2.2 +pyobjc-framework-ServiceManagement==6.2.2 +pyobjc-framework-Social==6.2.2 +pyobjc-framework-SoundAnalysis==6.2.2 +pyobjc-framework-Speech==6.2.2 +pyobjc-framework-SpriteKit==6.2.2 +pyobjc-framework-StoreKit==6.2.2 +pyobjc-framework-SyncServices==6.2.2 +pyobjc-framework-SystemConfiguration==6.2.2 +pyobjc-framework-SystemExtensions==6.2.2 +pyobjc-framework-UserNotifications==6.2.2 +pyobjc-framework-VideoSubscriberAccount==6.2.2 +pyobjc-framework-VideoToolbox==6.2.2 +pyobjc-framework-Vision==6.2.2 +pyobjc-framework-WebKit==6.2.2 +pyobjc-framework-XgridFoundation==6.2.2 +pyobjc-framework-iTunesLibrary==6.2.2 +pyobjc-framework-libdispatch==6.2.2 diff --git a/requirements/static/ci/py3.8/docs.txt b/requirements/static/ci/py3.8/docs.txt index 831e78bd3c1..30b09ae046a 100644 --- a/requirements/static/ci/py3.8/docs.txt +++ b/requirements/static/ci/py3.8/docs.txt @@ -13,11 +13,13 @@ chardet==3.0.4 cheroot==6.5.4 cherrypy==17.4.1 contextlib2==0.5.5 +contextvars==2.4 cryptography==3.3.2 distro==1.5.0 docutils==0.16 # via sphinx idna==2.8 imagesize==1.2.0 # via sphinx +immutables==0.15 jaraco.functools==2.0 jinja2==2.10.1 markupsafe==1.1.1 diff --git a/requirements/static/ci/py3.8/freebsd.txt b/requirements/static/ci/py3.8/freebsd.txt index 88b07c64aaa..f5e4ef9b251 100644 --- a/requirements/static/ci/py3.8/freebsd.txt +++ b/requirements/static/ci/py3.8/freebsd.txt @@ -115,6 +115,7 @@ click==7.1.2 # via geomet clustershell==1.8.3 colorama==0.4.3 # via ciscoconfparse contextlib2==0.5.5 +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.3.2 decorator==4.4.2 # via networkx @@ -134,6 +135,7 @@ gitdb==4.0.5 # via gitpython gitpython==3.1.12 google-auth==1.6.3 # via kubernetes idna==2.8 +immutables==0.15 iniconfig==1.0.1 # via pytest ipaddress==1.0.22 # via kubernetes isodate==0.6.0 # via msrest diff --git a/requirements/static/ci/py3.8/linux.txt b/requirements/static/ci/py3.8/linux.txt index fba67d95bd7..43ec2d8c271 100644 --- a/requirements/static/ci/py3.8/linux.txt +++ b/requirements/static/ci/py3.8/linux.txt @@ -116,6 +116,7 @@ click==7.1.1 # via geomet clustershell==1.8.3 colorama==0.4.3 # via ciscoconfparse contextlib2==0.5.5 +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.3.2 decorator==4.4.2 # via networkx @@ -135,6 +136,7 @@ gitdb==4.0.5 # via gitpython gitpython==3.1.12 google-auth==1.6.3 # via kubernetes idna==2.8 +immutables==0.15 iniconfig==1.0.1 # via pytest ipaddress==1.0.22 # via kubernetes isodate==0.6.0 # via msrest diff --git a/requirements/static/ci/py3.9/darwin.txt b/requirements/static/ci/py3.9/darwin.txt index 18b55d26d37..30e7f8aacf7 100644 --- a/requirements/static/ci/py3.9/darwin.txt +++ b/requirements/static/ci/py3.9/darwin.txt @@ -113,6 +113,7 @@ click==7.0 # via geomet clustershell==1.8.1 colorama==0.4.3 # via ciscoconfparse contextlib2==0.6.0.post1 +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.3.2 decorator==4.4.2 # via networkx @@ -132,6 +133,7 @@ gitdb==4.0.5 gitpython==3.1.12 google-auth==1.6.3 # via kubernetes idna==2.8 +immutables==0.15 iniconfig==1.0.1 # via pytest ipaddress==1.0.22 # via kubernetes isodate==0.6.0 # via msrest @@ -232,3 +234,122 @@ zc.lockfile==2.0 zipp==3.4.0 # via moto # Passthrough dependencies from requirements/static/pkg/py3.9/darwin.txt pyobjc==6.2.2 +pyobjc-core==6.2.2 +pyobjc-framework-AVFoundation==6.2.2 +pyobjc-framework-AVKit==6.2.2 +pyobjc-framework-Accounts==6.2.2 +pyobjc-framework-AdSupport==6.2.2 +pyobjc-framework-AddressBook==6.2.2 +pyobjc-framework-AppleScriptKit==6.2.2 +pyobjc-framework-AppleScriptObjC==6.2.2 +pyobjc-framework-ApplicationServices==6.2.2 +pyobjc-framework-AuthenticationServices==6.2.2 +pyobjc-framework-AutomaticAssessmentConfiguration==6.2.2 +pyobjc-framework-Automator==6.2.2 +pyobjc-framework-BusinessChat==6.2.2 +pyobjc-framework-CFNetwork==6.2.2 +pyobjc-framework-CalendarStore==6.2.2 +pyobjc-framework-CloudKit==6.2.2 +pyobjc-framework-Cocoa==6.2.2 +pyobjc-framework-Collaboration==6.2.2 +pyobjc-framework-ColorSync==6.2.2 +pyobjc-framework-Contacts==6.2.2 +pyobjc-framework-ContactsUI==6.2.2 +pyobjc-framework-CoreAudio==6.2.2 +pyobjc-framework-CoreAudioKit==6.2.2 +pyobjc-framework-CoreBluetooth==6.2.2 +pyobjc-framework-CoreData==6.2.2 +pyobjc-framework-CoreHaptics==6.2.2 +pyobjc-framework-CoreLocation==6.2.2 +pyobjc-framework-CoreML==6.2.2 +pyobjc-framework-CoreMedia==6.2.2 +pyobjc-framework-CoreMediaIO==6.2.2 +pyobjc-framework-CoreMotion==6.2.2 +pyobjc-framework-CoreServices==6.2.2 +pyobjc-framework-CoreSpotlight==6.2.2 +pyobjc-framework-CoreText==6.2.2 +pyobjc-framework-CoreWLAN==6.2.2 +pyobjc-framework-CryptoTokenKit==6.2.2 +pyobjc-framework-DVDPlayback==6.2.2 +pyobjc-framework-DeviceCheck==6.2.2 +pyobjc-framework-DictionaryServices==6.2.2 +pyobjc-framework-DiscRecording==6.2.2 +pyobjc-framework-DiscRecordingUI==6.2.2 +pyobjc-framework-DiskArbitration==6.2.2 +pyobjc-framework-EventKit==6.2.2 +pyobjc-framework-ExceptionHandling==6.2.2 +pyobjc-framework-ExecutionPolicy==6.2.2 +pyobjc-framework-ExternalAccessory==6.2.2 +pyobjc-framework-FSEvents==6.2.2 +pyobjc-framework-FileProvider==6.2.2 +pyobjc-framework-FileProviderUI==6.2.2 +pyobjc-framework-FinderSync==6.2.2 +pyobjc-framework-GameCenter==6.2.2 +pyobjc-framework-GameController==6.2.2 +pyobjc-framework-GameKit==6.2.2 +pyobjc-framework-GameplayKit==6.2.2 +pyobjc-framework-IMServicePlugIn==6.2.2 +pyobjc-framework-IOSurface==6.2.2 +pyobjc-framework-ImageCaptureCore==6.2.2 +pyobjc-framework-InputMethodKit==6.2.2 +pyobjc-framework-InstallerPlugins==6.2.2 +pyobjc-framework-InstantMessage==6.2.2 +pyobjc-framework-Intents==6.2.2 +pyobjc-framework-InterfaceBuilderKit==6.2.2 +pyobjc-framework-LatentSemanticMapping==6.2.2 +pyobjc-framework-LaunchServices==6.2.2 +pyobjc-framework-LinkPresentation==6.2.2 +pyobjc-framework-LocalAuthentication==6.2.2 +pyobjc-framework-MapKit==6.2.2 +pyobjc-framework-MediaAccessibility==6.2.2 +pyobjc-framework-MediaLibrary==6.2.2 +pyobjc-framework-MediaPlayer==6.2.2 +pyobjc-framework-MediaToolbox==6.2.2 +pyobjc-framework-Message==6.2.2 +pyobjc-framework-Metal==6.2.2 +pyobjc-framework-MetalKit==6.2.2 +pyobjc-framework-ModelIO==6.2.2 +pyobjc-framework-MultipeerConnectivity==6.2.2 +pyobjc-framework-NaturalLanguage==6.2.2 +pyobjc-framework-NetFS==6.2.2 +pyobjc-framework-Network==6.2.2 +pyobjc-framework-NetworkExtension==6.2.2 +pyobjc-framework-NotificationCenter==6.2.2 +pyobjc-framework-OSAKit==6.2.2 +pyobjc-framework-OSLog==6.2.2 +pyobjc-framework-OpenDirectory==6.2.2 +pyobjc-framework-PencilKit==6.2.2 +pyobjc-framework-Photos==6.2.2 +pyobjc-framework-PhotosUI==6.2.2 +pyobjc-framework-PreferencePanes==6.2.2 +pyobjc-framework-PubSub==6.2.2 +pyobjc-framework-PushKit==6.2.2 +pyobjc-framework-QTKit==6.2.2 +pyobjc-framework-Quartz==6.2.2 +pyobjc-framework-QuickLookThumbnailing==6.2.2 +pyobjc-framework-SafariServices==6.2.2 +pyobjc-framework-SceneKit==6.2.2 +pyobjc-framework-ScreenSaver==6.2.2 +pyobjc-framework-ScriptingBridge==6.2.2 +pyobjc-framework-SearchKit==6.2.2 +pyobjc-framework-Security==6.2.2 +pyobjc-framework-SecurityFoundation==6.2.2 +pyobjc-framework-SecurityInterface==6.2.2 +pyobjc-framework-ServerNotification==6.2.2 +pyobjc-framework-ServiceManagement==6.2.2 +pyobjc-framework-Social==6.2.2 +pyobjc-framework-SoundAnalysis==6.2.2 +pyobjc-framework-Speech==6.2.2 +pyobjc-framework-SpriteKit==6.2.2 +pyobjc-framework-StoreKit==6.2.2 +pyobjc-framework-SyncServices==6.2.2 +pyobjc-framework-SystemConfiguration==6.2.2 +pyobjc-framework-SystemExtensions==6.2.2 +pyobjc-framework-UserNotifications==6.2.2 +pyobjc-framework-VideoSubscriberAccount==6.2.2 +pyobjc-framework-VideoToolbox==6.2.2 +pyobjc-framework-Vision==6.2.2 +pyobjc-framework-WebKit==6.2.2 +pyobjc-framework-XgridFoundation==6.2.2 +pyobjc-framework-iTunesLibrary==6.2.2 +pyobjc-framework-libdispatch==6.2.2 diff --git a/requirements/static/ci/py3.9/docs.txt b/requirements/static/ci/py3.9/docs.txt index 95542b83eaa..f9e1df50bdf 100644 --- a/requirements/static/ci/py3.9/docs.txt +++ b/requirements/static/ci/py3.9/docs.txt @@ -13,11 +13,13 @@ chardet==3.0.4 cheroot==6.5.4 cherrypy==17.4.1 contextlib2==0.5.5 +contextvars==2.4 cryptography==3.3.2 distro==1.5.0 docutils==0.16 # via sphinx idna==2.8 imagesize==1.2.0 # via sphinx +immutables==0.15 jaraco.functools==2.0 jinja2==2.10.1 markupsafe==1.1.1 diff --git a/requirements/static/ci/py3.9/freebsd.txt b/requirements/static/ci/py3.9/freebsd.txt index d76696a34cb..129480f9375 100644 --- a/requirements/static/ci/py3.9/freebsd.txt +++ b/requirements/static/ci/py3.9/freebsd.txt @@ -115,6 +115,7 @@ click==7.1.2 # via geomet clustershell==1.8.3 colorama==0.4.3 # via ciscoconfparse contextlib2==0.5.5 +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.3.2 decorator==4.4.2 # via networkx @@ -134,6 +135,7 @@ gitdb==4.0.5 # via gitpython gitpython==3.1.12 google-auth==1.6.3 # via kubernetes idna==2.8 +immutables==0.15 iniconfig==1.0.1 # via pytest ipaddress==1.0.22 # via kubernetes isodate==0.6.0 # via msrest diff --git a/requirements/static/ci/py3.9/linux.txt b/requirements/static/ci/py3.9/linux.txt index cf4710740f3..64b75f03b90 100644 --- a/requirements/static/ci/py3.9/linux.txt +++ b/requirements/static/ci/py3.9/linux.txt @@ -117,6 +117,7 @@ click==7.1.1 # via geomet clustershell==1.8.3 colorama==0.4.3 # via ciscoconfparse contextlib2==0.5.5 +contextvars==2.4 croniter==0.3.29 ; sys_platform != "win32" cryptography==3.3.2 decorator==4.4.2 # via networkx @@ -136,6 +137,7 @@ gitdb==4.0.5 # via gitpython gitpython==3.1.12 google-auth==1.6.3 # via kubernetes idna==2.8 +immutables==0.15 iniconfig==1.0.1 # via pytest ipaddress==1.0.22 # via kubernetes isodate==0.6.0 # via msrest diff --git a/requirements/static/pkg/py3.5/darwin.txt b/requirements/static/pkg/py3.5/darwin.txt index fa4cb47d1fa..89123e4a593 100644 --- a/requirements/static/pkg/py3.5/darwin.txt +++ b/requirements/static/pkg/py3.5/darwin.txt @@ -2,7 +2,7 @@ # This file is autogenerated by pip-compile # To update, run: # -# pip-compile -o requirements/static/pkg/py3.5/darwin.txt -v requirements/darwin.txt requirements/static/pkg/darwin.in +# pip-compile -o requirements/static/pkg/py3.5/darwin.txt -v requirements/darwin.txt requirements/pyobjc.txt requirements/static/pkg/darwin.in # apache-libcloud==2.5.0 backports.ssl-match-hostname==3.7.0.1 ; python_version < "3.7" @@ -12,7 +12,7 @@ chardet==3.0.4 # via requests cheroot==8.3.0 # via cherrypy cherrypy==17.4.1 contextlib2==0.6.0.post1 # via cherrypy -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 cryptography==3.0 distro==1.5.0 gitdb==4.0.5 # via gitpython @@ -46,5 +46,124 @@ timelib==0.2.5 urllib3==1.24.3 # via requests vultr==1.0.1 zc.lockfile==2.0 # via cherrypy -# Passthrough dependencies from requirements/darwin.txt +# Passthrough dependencies from requirements/pyobjc.txt pyobjc==6.2.2 +pyobjc-core==6.2.2 +pyobjc-framework-AVFoundation==6.2.2 +pyobjc-framework-AVKit==6.2.2 +pyobjc-framework-Accounts==6.2.2 +pyobjc-framework-AdSupport==6.2.2 +pyobjc-framework-AddressBook==6.2.2 +pyobjc-framework-AppleScriptKit==6.2.2 +pyobjc-framework-AppleScriptObjC==6.2.2 +pyobjc-framework-ApplicationServices==6.2.2 +pyobjc-framework-AuthenticationServices==6.2.2 +pyobjc-framework-AutomaticAssessmentConfiguration==6.2.2 +pyobjc-framework-Automator==6.2.2 +pyobjc-framework-BusinessChat==6.2.2 +pyobjc-framework-CFNetwork==6.2.2 +pyobjc-framework-CalendarStore==6.2.2 +pyobjc-framework-CloudKit==6.2.2 +pyobjc-framework-Cocoa==6.2.2 +pyobjc-framework-Collaboration==6.2.2 +pyobjc-framework-ColorSync==6.2.2 +pyobjc-framework-Contacts==6.2.2 +pyobjc-framework-ContactsUI==6.2.2 +pyobjc-framework-CoreAudio==6.2.2 +pyobjc-framework-CoreAudioKit==6.2.2 +pyobjc-framework-CoreBluetooth==6.2.2 +pyobjc-framework-CoreData==6.2.2 +pyobjc-framework-CoreHaptics==6.2.2 +pyobjc-framework-CoreLocation==6.2.2 +pyobjc-framework-CoreML==6.2.2 +pyobjc-framework-CoreMedia==6.2.2 +pyobjc-framework-CoreMediaIO==6.2.2 +pyobjc-framework-CoreMotion==6.2.2 +pyobjc-framework-CoreServices==6.2.2 +pyobjc-framework-CoreSpotlight==6.2.2 +pyobjc-framework-CoreText==6.2.2 +pyobjc-framework-CoreWLAN==6.2.2 +pyobjc-framework-CryptoTokenKit==6.2.2 +pyobjc-framework-DVDPlayback==6.2.2 +pyobjc-framework-DeviceCheck==6.2.2 +pyobjc-framework-DictionaryServices==6.2.2 +pyobjc-framework-DiscRecording==6.2.2 +pyobjc-framework-DiscRecordingUI==6.2.2 +pyobjc-framework-DiskArbitration==6.2.2 +pyobjc-framework-EventKit==6.2.2 +pyobjc-framework-ExceptionHandling==6.2.2 +pyobjc-framework-ExecutionPolicy==6.2.2 +pyobjc-framework-ExternalAccessory==6.2.2 +pyobjc-framework-FSEvents==6.2.2 +pyobjc-framework-FileProvider==6.2.2 +pyobjc-framework-FileProviderUI==6.2.2 +pyobjc-framework-FinderSync==6.2.2 +pyobjc-framework-GameCenter==6.2.2 +pyobjc-framework-GameController==6.2.2 +pyobjc-framework-GameKit==6.2.2 +pyobjc-framework-GameplayKit==6.2.2 +pyobjc-framework-IMServicePlugIn==6.2.2 +pyobjc-framework-IOSurface==6.2.2 +pyobjc-framework-ImageCaptureCore==6.2.2 +pyobjc-framework-InputMethodKit==6.2.2 +pyobjc-framework-InstallerPlugins==6.2.2 +pyobjc-framework-InstantMessage==6.2.2 +pyobjc-framework-Intents==6.2.2 +pyobjc-framework-InterfaceBuilderKit==6.2.2 +pyobjc-framework-LatentSemanticMapping==6.2.2 +pyobjc-framework-LaunchServices==6.2.2 +pyobjc-framework-LinkPresentation==6.2.2 +pyobjc-framework-LocalAuthentication==6.2.2 +pyobjc-framework-MapKit==6.2.2 +pyobjc-framework-MediaAccessibility==6.2.2 +pyobjc-framework-MediaLibrary==6.2.2 +pyobjc-framework-MediaPlayer==6.2.2 +pyobjc-framework-MediaToolbox==6.2.2 +pyobjc-framework-Message==6.2.2 +pyobjc-framework-Metal==6.2.2 +pyobjc-framework-MetalKit==6.2.2 +pyobjc-framework-ModelIO==6.2.2 +pyobjc-framework-MultipeerConnectivity==6.2.2 +pyobjc-framework-NaturalLanguage==6.2.2 +pyobjc-framework-NetFS==6.2.2 +pyobjc-framework-Network==6.2.2 +pyobjc-framework-NetworkExtension==6.2.2 +pyobjc-framework-NotificationCenter==6.2.2 +pyobjc-framework-OSAKit==6.2.2 +pyobjc-framework-OSLog==6.2.2 +pyobjc-framework-OpenDirectory==6.2.2 +pyobjc-framework-PencilKit==6.2.2 +pyobjc-framework-Photos==6.2.2 +pyobjc-framework-PhotosUI==6.2.2 +pyobjc-framework-PreferencePanes==6.2.2 +pyobjc-framework-PubSub==6.2.2 +pyobjc-framework-PushKit==6.2.2 +pyobjc-framework-QTKit==6.2.2 +pyobjc-framework-Quartz==6.2.2 +pyobjc-framework-QuickLookThumbnailing==6.2.2 +pyobjc-framework-SafariServices==6.2.2 +pyobjc-framework-SceneKit==6.2.2 +pyobjc-framework-ScreenSaver==6.2.2 +pyobjc-framework-ScriptingBridge==6.2.2 +pyobjc-framework-SearchKit==6.2.2 +pyobjc-framework-Security==6.2.2 +pyobjc-framework-SecurityFoundation==6.2.2 +pyobjc-framework-SecurityInterface==6.2.2 +pyobjc-framework-ServerNotification==6.2.2 +pyobjc-framework-ServiceManagement==6.2.2 +pyobjc-framework-Social==6.2.2 +pyobjc-framework-SoundAnalysis==6.2.2 +pyobjc-framework-Speech==6.2.2 +pyobjc-framework-SpriteKit==6.2.2 +pyobjc-framework-StoreKit==6.2.2 +pyobjc-framework-SyncServices==6.2.2 +pyobjc-framework-SystemConfiguration==6.2.2 +pyobjc-framework-SystemExtensions==6.2.2 +pyobjc-framework-UserNotifications==6.2.2 +pyobjc-framework-VideoSubscriberAccount==6.2.2 +pyobjc-framework-VideoToolbox==6.2.2 +pyobjc-framework-Vision==6.2.2 +pyobjc-framework-WebKit==6.2.2 +pyobjc-framework-XgridFoundation==6.2.2 +pyobjc-framework-iTunesLibrary==6.2.2 +pyobjc-framework-libdispatch==6.2.2 diff --git a/requirements/static/pkg/py3.5/freebsd.txt b/requirements/static/pkg/py3.5/freebsd.txt index 71259eee0bf..fd7a5add118 100644 --- a/requirements/static/pkg/py3.5/freebsd.txt +++ b/requirements/static/pkg/py3.5/freebsd.txt @@ -12,7 +12,7 @@ chardet==3.0.4 # via requests cheroot==6.5.4 # via cherrypy cherrypy==17.4.1 contextlib2==0.5.5 # via cherrypy -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 cryptography==3.0 # via pyopenssl distro==1.5.0 idna==2.8 # via requests diff --git a/requirements/static/pkg/py3.5/linux.txt b/requirements/static/pkg/py3.5/linux.txt index ff181ca3b07..9a32258d9c6 100644 --- a/requirements/static/pkg/py3.5/linux.txt +++ b/requirements/static/pkg/py3.5/linux.txt @@ -12,7 +12,7 @@ chardet==3.0.4 # via requests cheroot==6.5.4 # via cherrypy cherrypy==17.4.1 contextlib2==0.5.5 # via cherrypy -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 cryptography==3.0 # via pyopenssl distro==1.5.0 idna==2.8 # via requests diff --git a/requirements/static/pkg/py3.6/darwin.txt b/requirements/static/pkg/py3.6/darwin.txt index 9e716aaf4b1..ff8f66f9987 100644 --- a/requirements/static/pkg/py3.6/darwin.txt +++ b/requirements/static/pkg/py3.6/darwin.txt @@ -2,7 +2,7 @@ # This file is autogenerated by pip-compile # To update, run: # -# pip-compile -o requirements/static/pkg/py3.6/darwin.txt -v requirements/darwin.txt requirements/static/pkg/darwin.in +# pip-compile -o requirements/static/pkg/py3.6/darwin.txt -v requirements/darwin.txt requirements/pyobjc.txt requirements/static/pkg/darwin.in # apache-libcloud==2.5.0 backports.ssl-match-hostname==3.7.0.1 ; python_version < "3.7" @@ -12,7 +12,7 @@ chardet==3.0.4 # via requests cheroot==8.3.0 # via cherrypy cherrypy==17.4.1 contextlib2==0.6.0.post1 # via cherrypy -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 cryptography==3.3.2 distro==1.5.0 gitdb==4.0.5 # via gitpython @@ -46,5 +46,124 @@ timelib==0.2.5 urllib3==1.24.3 # via requests vultr==1.0.1 zc.lockfile==2.0 # via cherrypy -# Passthrough dependencies from requirements/darwin.txt +# Passthrough dependencies from requirements/pyobjc.txt pyobjc==6.2.2 +pyobjc-core==6.2.2 +pyobjc-framework-AVFoundation==6.2.2 +pyobjc-framework-AVKit==6.2.2 +pyobjc-framework-Accounts==6.2.2 +pyobjc-framework-AdSupport==6.2.2 +pyobjc-framework-AddressBook==6.2.2 +pyobjc-framework-AppleScriptKit==6.2.2 +pyobjc-framework-AppleScriptObjC==6.2.2 +pyobjc-framework-ApplicationServices==6.2.2 +pyobjc-framework-AuthenticationServices==6.2.2 +pyobjc-framework-AutomaticAssessmentConfiguration==6.2.2 +pyobjc-framework-Automator==6.2.2 +pyobjc-framework-BusinessChat==6.2.2 +pyobjc-framework-CFNetwork==6.2.2 +pyobjc-framework-CalendarStore==6.2.2 +pyobjc-framework-CloudKit==6.2.2 +pyobjc-framework-Cocoa==6.2.2 +pyobjc-framework-Collaboration==6.2.2 +pyobjc-framework-ColorSync==6.2.2 +pyobjc-framework-Contacts==6.2.2 +pyobjc-framework-ContactsUI==6.2.2 +pyobjc-framework-CoreAudio==6.2.2 +pyobjc-framework-CoreAudioKit==6.2.2 +pyobjc-framework-CoreBluetooth==6.2.2 +pyobjc-framework-CoreData==6.2.2 +pyobjc-framework-CoreHaptics==6.2.2 +pyobjc-framework-CoreLocation==6.2.2 +pyobjc-framework-CoreML==6.2.2 +pyobjc-framework-CoreMedia==6.2.2 +pyobjc-framework-CoreMediaIO==6.2.2 +pyobjc-framework-CoreMotion==6.2.2 +pyobjc-framework-CoreServices==6.2.2 +pyobjc-framework-CoreSpotlight==6.2.2 +pyobjc-framework-CoreText==6.2.2 +pyobjc-framework-CoreWLAN==6.2.2 +pyobjc-framework-CryptoTokenKit==6.2.2 +pyobjc-framework-DVDPlayback==6.2.2 +pyobjc-framework-DeviceCheck==6.2.2 +pyobjc-framework-DictionaryServices==6.2.2 +pyobjc-framework-DiscRecording==6.2.2 +pyobjc-framework-DiscRecordingUI==6.2.2 +pyobjc-framework-DiskArbitration==6.2.2 +pyobjc-framework-EventKit==6.2.2 +pyobjc-framework-ExceptionHandling==6.2.2 +pyobjc-framework-ExecutionPolicy==6.2.2 +pyobjc-framework-ExternalAccessory==6.2.2 +pyobjc-framework-FSEvents==6.2.2 +pyobjc-framework-FileProvider==6.2.2 +pyobjc-framework-FileProviderUI==6.2.2 +pyobjc-framework-FinderSync==6.2.2 +pyobjc-framework-GameCenter==6.2.2 +pyobjc-framework-GameController==6.2.2 +pyobjc-framework-GameKit==6.2.2 +pyobjc-framework-GameplayKit==6.2.2 +pyobjc-framework-IMServicePlugIn==6.2.2 +pyobjc-framework-IOSurface==6.2.2 +pyobjc-framework-ImageCaptureCore==6.2.2 +pyobjc-framework-InputMethodKit==6.2.2 +pyobjc-framework-InstallerPlugins==6.2.2 +pyobjc-framework-InstantMessage==6.2.2 +pyobjc-framework-Intents==6.2.2 +pyobjc-framework-InterfaceBuilderKit==6.2.2 +pyobjc-framework-LatentSemanticMapping==6.2.2 +pyobjc-framework-LaunchServices==6.2.2 +pyobjc-framework-LinkPresentation==6.2.2 +pyobjc-framework-LocalAuthentication==6.2.2 +pyobjc-framework-MapKit==6.2.2 +pyobjc-framework-MediaAccessibility==6.2.2 +pyobjc-framework-MediaLibrary==6.2.2 +pyobjc-framework-MediaPlayer==6.2.2 +pyobjc-framework-MediaToolbox==6.2.2 +pyobjc-framework-Message==6.2.2 +pyobjc-framework-Metal==6.2.2 +pyobjc-framework-MetalKit==6.2.2 +pyobjc-framework-ModelIO==6.2.2 +pyobjc-framework-MultipeerConnectivity==6.2.2 +pyobjc-framework-NaturalLanguage==6.2.2 +pyobjc-framework-NetFS==6.2.2 +pyobjc-framework-Network==6.2.2 +pyobjc-framework-NetworkExtension==6.2.2 +pyobjc-framework-NotificationCenter==6.2.2 +pyobjc-framework-OSAKit==6.2.2 +pyobjc-framework-OSLog==6.2.2 +pyobjc-framework-OpenDirectory==6.2.2 +pyobjc-framework-PencilKit==6.2.2 +pyobjc-framework-Photos==6.2.2 +pyobjc-framework-PhotosUI==6.2.2 +pyobjc-framework-PreferencePanes==6.2.2 +pyobjc-framework-PubSub==6.2.2 +pyobjc-framework-PushKit==6.2.2 +pyobjc-framework-QTKit==6.2.2 +pyobjc-framework-Quartz==6.2.2 +pyobjc-framework-QuickLookThumbnailing==6.2.2 +pyobjc-framework-SafariServices==6.2.2 +pyobjc-framework-SceneKit==6.2.2 +pyobjc-framework-ScreenSaver==6.2.2 +pyobjc-framework-ScriptingBridge==6.2.2 +pyobjc-framework-SearchKit==6.2.2 +pyobjc-framework-Security==6.2.2 +pyobjc-framework-SecurityFoundation==6.2.2 +pyobjc-framework-SecurityInterface==6.2.2 +pyobjc-framework-ServerNotification==6.2.2 +pyobjc-framework-ServiceManagement==6.2.2 +pyobjc-framework-Social==6.2.2 +pyobjc-framework-SoundAnalysis==6.2.2 +pyobjc-framework-Speech==6.2.2 +pyobjc-framework-SpriteKit==6.2.2 +pyobjc-framework-StoreKit==6.2.2 +pyobjc-framework-SyncServices==6.2.2 +pyobjc-framework-SystemConfiguration==6.2.2 +pyobjc-framework-SystemExtensions==6.2.2 +pyobjc-framework-UserNotifications==6.2.2 +pyobjc-framework-VideoSubscriberAccount==6.2.2 +pyobjc-framework-VideoToolbox==6.2.2 +pyobjc-framework-Vision==6.2.2 +pyobjc-framework-WebKit==6.2.2 +pyobjc-framework-XgridFoundation==6.2.2 +pyobjc-framework-iTunesLibrary==6.2.2 +pyobjc-framework-libdispatch==6.2.2 diff --git a/requirements/static/pkg/py3.6/freebsd.txt b/requirements/static/pkg/py3.6/freebsd.txt index 8d5561dab0e..ee32c7f3a65 100644 --- a/requirements/static/pkg/py3.6/freebsd.txt +++ b/requirements/static/pkg/py3.6/freebsd.txt @@ -12,7 +12,7 @@ chardet==3.0.4 # via requests cheroot==6.5.4 # via cherrypy cherrypy==17.4.1 contextlib2==0.5.5 # via cherrypy -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 cryptography==3.3.2 # via pyopenssl distro==1.5.0 idna==2.8 # via requests diff --git a/requirements/static/pkg/py3.6/linux.txt b/requirements/static/pkg/py3.6/linux.txt index 28dac0b240d..3533ed448a7 100644 --- a/requirements/static/pkg/py3.6/linux.txt +++ b/requirements/static/pkg/py3.6/linux.txt @@ -12,7 +12,7 @@ chardet==3.0.4 # via requests cheroot==6.5.4 # via cherrypy cherrypy==17.4.1 contextlib2==0.5.5 # via cherrypy -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 cryptography==3.3.2 # via pyopenssl distro==1.5.0 idna==2.8 # via requests diff --git a/requirements/static/pkg/py3.6/windows.txt b/requirements/static/pkg/py3.6/windows.txt index 83a5434292c..38ea14292e9 100644 --- a/requirements/static/pkg/py3.6/windows.txt +++ b/requirements/static/pkg/py3.6/windows.txt @@ -10,7 +10,7 @@ cffi==1.14.5 chardet==3.0.4 # via requests cheroot==8.3.0 # via cherrypy cherrypy==18.6.0 -contextvars==2.4 ; python_version < "3.7" +contextvars==2.4 cryptography==3.4.6 distro==1.5.0 gitdb==4.0.5 # via gitpython diff --git a/requirements/static/pkg/py3.7/darwin.txt b/requirements/static/pkg/py3.7/darwin.txt index 07b07263a32..4658a39297a 100644 --- a/requirements/static/pkg/py3.7/darwin.txt +++ b/requirements/static/pkg/py3.7/darwin.txt @@ -2,7 +2,7 @@ # This file is autogenerated by pip-compile # To update, run: # -# pip-compile -o requirements/static/pkg/py3.7/darwin.txt -v requirements/darwin.txt requirements/static/pkg/darwin.in +# pip-compile -o requirements/static/pkg/py3.7/darwin.txt -v requirements/darwin.txt requirements/pyobjc.txt requirements/static/pkg/darwin.in # apache-libcloud==2.5.0 certifi==2020.6.20 # via requests @@ -11,11 +11,13 @@ chardet==3.0.4 # via requests cheroot==8.3.0 # via cherrypy cherrypy==17.4.1 contextlib2==0.6.0.post1 # via cherrypy +contextvars==2.4 cryptography==3.3.2 distro==1.5.0 gitdb==4.0.5 # via gitpython gitpython==3.1.12 idna==2.8 +immutables==0.15 # via contextvars jaraco.functools==2.0 # via cheroot, tempora jinja2==2.10.1 linode-python==1.1.1 @@ -43,5 +45,124 @@ timelib==0.2.5 urllib3==1.24.3 # via requests vultr==1.0.1 zc.lockfile==2.0 # via cherrypy -# Passthrough dependencies from requirements/darwin.txt +# Passthrough dependencies from requirements/pyobjc.txt pyobjc==6.2.2 +pyobjc-core==6.2.2 +pyobjc-framework-AVFoundation==6.2.2 +pyobjc-framework-AVKit==6.2.2 +pyobjc-framework-Accounts==6.2.2 +pyobjc-framework-AdSupport==6.2.2 +pyobjc-framework-AddressBook==6.2.2 +pyobjc-framework-AppleScriptKit==6.2.2 +pyobjc-framework-AppleScriptObjC==6.2.2 +pyobjc-framework-ApplicationServices==6.2.2 +pyobjc-framework-AuthenticationServices==6.2.2 +pyobjc-framework-AutomaticAssessmentConfiguration==6.2.2 +pyobjc-framework-Automator==6.2.2 +pyobjc-framework-BusinessChat==6.2.2 +pyobjc-framework-CFNetwork==6.2.2 +pyobjc-framework-CalendarStore==6.2.2 +pyobjc-framework-CloudKit==6.2.2 +pyobjc-framework-Cocoa==6.2.2 +pyobjc-framework-Collaboration==6.2.2 +pyobjc-framework-ColorSync==6.2.2 +pyobjc-framework-Contacts==6.2.2 +pyobjc-framework-ContactsUI==6.2.2 +pyobjc-framework-CoreAudio==6.2.2 +pyobjc-framework-CoreAudioKit==6.2.2 +pyobjc-framework-CoreBluetooth==6.2.2 +pyobjc-framework-CoreData==6.2.2 +pyobjc-framework-CoreHaptics==6.2.2 +pyobjc-framework-CoreLocation==6.2.2 +pyobjc-framework-CoreML==6.2.2 +pyobjc-framework-CoreMedia==6.2.2 +pyobjc-framework-CoreMediaIO==6.2.2 +pyobjc-framework-CoreMotion==6.2.2 +pyobjc-framework-CoreServices==6.2.2 +pyobjc-framework-CoreSpotlight==6.2.2 +pyobjc-framework-CoreText==6.2.2 +pyobjc-framework-CoreWLAN==6.2.2 +pyobjc-framework-CryptoTokenKit==6.2.2 +pyobjc-framework-DVDPlayback==6.2.2 +pyobjc-framework-DeviceCheck==6.2.2 +pyobjc-framework-DictionaryServices==6.2.2 +pyobjc-framework-DiscRecording==6.2.2 +pyobjc-framework-DiscRecordingUI==6.2.2 +pyobjc-framework-DiskArbitration==6.2.2 +pyobjc-framework-EventKit==6.2.2 +pyobjc-framework-ExceptionHandling==6.2.2 +pyobjc-framework-ExecutionPolicy==6.2.2 +pyobjc-framework-ExternalAccessory==6.2.2 +pyobjc-framework-FSEvents==6.2.2 +pyobjc-framework-FileProvider==6.2.2 +pyobjc-framework-FileProviderUI==6.2.2 +pyobjc-framework-FinderSync==6.2.2 +pyobjc-framework-GameCenter==6.2.2 +pyobjc-framework-GameController==6.2.2 +pyobjc-framework-GameKit==6.2.2 +pyobjc-framework-GameplayKit==6.2.2 +pyobjc-framework-IMServicePlugIn==6.2.2 +pyobjc-framework-IOSurface==6.2.2 +pyobjc-framework-ImageCaptureCore==6.2.2 +pyobjc-framework-InputMethodKit==6.2.2 +pyobjc-framework-InstallerPlugins==6.2.2 +pyobjc-framework-InstantMessage==6.2.2 +pyobjc-framework-Intents==6.2.2 +pyobjc-framework-InterfaceBuilderKit==6.2.2 +pyobjc-framework-LatentSemanticMapping==6.2.2 +pyobjc-framework-LaunchServices==6.2.2 +pyobjc-framework-LinkPresentation==6.2.2 +pyobjc-framework-LocalAuthentication==6.2.2 +pyobjc-framework-MapKit==6.2.2 +pyobjc-framework-MediaAccessibility==6.2.2 +pyobjc-framework-MediaLibrary==6.2.2 +pyobjc-framework-MediaPlayer==6.2.2 +pyobjc-framework-MediaToolbox==6.2.2 +pyobjc-framework-Message==6.2.2 +pyobjc-framework-Metal==6.2.2 +pyobjc-framework-MetalKit==6.2.2 +pyobjc-framework-ModelIO==6.2.2 +pyobjc-framework-MultipeerConnectivity==6.2.2 +pyobjc-framework-NaturalLanguage==6.2.2 +pyobjc-framework-NetFS==6.2.2 +pyobjc-framework-Network==6.2.2 +pyobjc-framework-NetworkExtension==6.2.2 +pyobjc-framework-NotificationCenter==6.2.2 +pyobjc-framework-OSAKit==6.2.2 +pyobjc-framework-OSLog==6.2.2 +pyobjc-framework-OpenDirectory==6.2.2 +pyobjc-framework-PencilKit==6.2.2 +pyobjc-framework-Photos==6.2.2 +pyobjc-framework-PhotosUI==6.2.2 +pyobjc-framework-PreferencePanes==6.2.2 +pyobjc-framework-PubSub==6.2.2 +pyobjc-framework-PushKit==6.2.2 +pyobjc-framework-QTKit==6.2.2 +pyobjc-framework-Quartz==6.2.2 +pyobjc-framework-QuickLookThumbnailing==6.2.2 +pyobjc-framework-SafariServices==6.2.2 +pyobjc-framework-SceneKit==6.2.2 +pyobjc-framework-ScreenSaver==6.2.2 +pyobjc-framework-ScriptingBridge==6.2.2 +pyobjc-framework-SearchKit==6.2.2 +pyobjc-framework-Security==6.2.2 +pyobjc-framework-SecurityFoundation==6.2.2 +pyobjc-framework-SecurityInterface==6.2.2 +pyobjc-framework-ServerNotification==6.2.2 +pyobjc-framework-ServiceManagement==6.2.2 +pyobjc-framework-Social==6.2.2 +pyobjc-framework-SoundAnalysis==6.2.2 +pyobjc-framework-Speech==6.2.2 +pyobjc-framework-SpriteKit==6.2.2 +pyobjc-framework-StoreKit==6.2.2 +pyobjc-framework-SyncServices==6.2.2 +pyobjc-framework-SystemConfiguration==6.2.2 +pyobjc-framework-SystemExtensions==6.2.2 +pyobjc-framework-UserNotifications==6.2.2 +pyobjc-framework-VideoSubscriberAccount==6.2.2 +pyobjc-framework-VideoToolbox==6.2.2 +pyobjc-framework-Vision==6.2.2 +pyobjc-framework-WebKit==6.2.2 +pyobjc-framework-XgridFoundation==6.2.2 +pyobjc-framework-iTunesLibrary==6.2.2 +pyobjc-framework-libdispatch==6.2.2 diff --git a/requirements/static/pkg/py3.7/freebsd.txt b/requirements/static/pkg/py3.7/freebsd.txt index 4e929dcca91..967c42d9fa7 100644 --- a/requirements/static/pkg/py3.7/freebsd.txt +++ b/requirements/static/pkg/py3.7/freebsd.txt @@ -11,9 +11,11 @@ chardet==3.0.4 # via requests cheroot==6.5.4 # via cherrypy cherrypy==17.4.1 contextlib2==0.5.5 # via cherrypy +contextvars==2.4 cryptography==3.3.2 # via pyopenssl distro==1.5.0 idna==2.8 # via requests +immutables==0.15 # via contextvars jaraco.functools==2.0 # via tempora jinja2==2.10.1 markupsafe==1.1.1 diff --git a/requirements/static/pkg/py3.7/linux.txt b/requirements/static/pkg/py3.7/linux.txt index 56bf1274026..6fcf8b5dc4f 100644 --- a/requirements/static/pkg/py3.7/linux.txt +++ b/requirements/static/pkg/py3.7/linux.txt @@ -11,9 +11,11 @@ chardet==3.0.4 # via requests cheroot==6.5.4 # via cherrypy cherrypy==17.4.1 contextlib2==0.5.5 # via cherrypy +contextvars==2.4 cryptography==3.3.2 # via pyopenssl distro==1.5.0 idna==2.8 # via requests +immutables==0.15 # via contextvars jaraco.functools==2.0 # via tempora jinja2==2.10.1 markupsafe==1.1.1 diff --git a/requirements/static/pkg/py3.7/windows.txt b/requirements/static/pkg/py3.7/windows.txt index 43dd7265ab0..c1a547bb252 100644 --- a/requirements/static/pkg/py3.7/windows.txt +++ b/requirements/static/pkg/py3.7/windows.txt @@ -9,11 +9,13 @@ cffi==1.14.5 chardet==3.0.4 # via requests cheroot==8.3.0 # via cherrypy cherrypy==18.6.0 +contextvars==2.4 cryptography==3.4.6 distro==1.5.0 gitdb==4.0.5 # via gitpython gitpython==3.1.13 idna==2.8 # via requests +immutables==0.15 # via contextvars ioloop==0.1a0 jaraco.classes==3.2.1 # via jaraco.collections jaraco.collections==3.2.0 # via cherrypy diff --git a/requirements/static/pkg/py3.8/darwin.txt b/requirements/static/pkg/py3.8/darwin.txt index c779374798c..c14eab7820a 100644 --- a/requirements/static/pkg/py3.8/darwin.txt +++ b/requirements/static/pkg/py3.8/darwin.txt @@ -2,7 +2,7 @@ # This file is autogenerated by pip-compile # To update, run: # -# pip-compile -o requirements/static/pkg/py3.8/darwin.txt -v requirements/darwin.txt requirements/static/pkg/darwin.in +# pip-compile -o requirements/static/pkg/py3.8/darwin.txt -v requirements/darwin.txt requirements/pyobjc.txt requirements/static/pkg/darwin.in # apache-libcloud==2.5.0 certifi==2020.6.20 # via requests @@ -11,11 +11,13 @@ chardet==3.0.4 # via requests cheroot==8.3.0 # via cherrypy cherrypy==17.4.1 contextlib2==0.6.0.post1 # via cherrypy +contextvars==2.4 cryptography==3.3.2 distro==1.5.0 gitdb==4.0.5 # via gitpython gitpython==3.1.12 idna==2.8 +immutables==0.15 # via contextvars jaraco.functools==2.0 # via cheroot, tempora jinja2==2.10.1 linode-python==1.1.1 @@ -43,5 +45,124 @@ timelib==0.2.5 urllib3==1.24.3 # via requests vultr==1.0.1 zc.lockfile==2.0 # via cherrypy -# Passthrough dependencies from requirements/darwin.txt +# Passthrough dependencies from requirements/pyobjc.txt pyobjc==6.2.2 +pyobjc-core==6.2.2 +pyobjc-framework-AVFoundation==6.2.2 +pyobjc-framework-AVKit==6.2.2 +pyobjc-framework-Accounts==6.2.2 +pyobjc-framework-AdSupport==6.2.2 +pyobjc-framework-AddressBook==6.2.2 +pyobjc-framework-AppleScriptKit==6.2.2 +pyobjc-framework-AppleScriptObjC==6.2.2 +pyobjc-framework-ApplicationServices==6.2.2 +pyobjc-framework-AuthenticationServices==6.2.2 +pyobjc-framework-AutomaticAssessmentConfiguration==6.2.2 +pyobjc-framework-Automator==6.2.2 +pyobjc-framework-BusinessChat==6.2.2 +pyobjc-framework-CFNetwork==6.2.2 +pyobjc-framework-CalendarStore==6.2.2 +pyobjc-framework-CloudKit==6.2.2 +pyobjc-framework-Cocoa==6.2.2 +pyobjc-framework-Collaboration==6.2.2 +pyobjc-framework-ColorSync==6.2.2 +pyobjc-framework-Contacts==6.2.2 +pyobjc-framework-ContactsUI==6.2.2 +pyobjc-framework-CoreAudio==6.2.2 +pyobjc-framework-CoreAudioKit==6.2.2 +pyobjc-framework-CoreBluetooth==6.2.2 +pyobjc-framework-CoreData==6.2.2 +pyobjc-framework-CoreHaptics==6.2.2 +pyobjc-framework-CoreLocation==6.2.2 +pyobjc-framework-CoreML==6.2.2 +pyobjc-framework-CoreMedia==6.2.2 +pyobjc-framework-CoreMediaIO==6.2.2 +pyobjc-framework-CoreMotion==6.2.2 +pyobjc-framework-CoreServices==6.2.2 +pyobjc-framework-CoreSpotlight==6.2.2 +pyobjc-framework-CoreText==6.2.2 +pyobjc-framework-CoreWLAN==6.2.2 +pyobjc-framework-CryptoTokenKit==6.2.2 +pyobjc-framework-DVDPlayback==6.2.2 +pyobjc-framework-DeviceCheck==6.2.2 +pyobjc-framework-DictionaryServices==6.2.2 +pyobjc-framework-DiscRecording==6.2.2 +pyobjc-framework-DiscRecordingUI==6.2.2 +pyobjc-framework-DiskArbitration==6.2.2 +pyobjc-framework-EventKit==6.2.2 +pyobjc-framework-ExceptionHandling==6.2.2 +pyobjc-framework-ExecutionPolicy==6.2.2 +pyobjc-framework-ExternalAccessory==6.2.2 +pyobjc-framework-FSEvents==6.2.2 +pyobjc-framework-FileProvider==6.2.2 +pyobjc-framework-FileProviderUI==6.2.2 +pyobjc-framework-FinderSync==6.2.2 +pyobjc-framework-GameCenter==6.2.2 +pyobjc-framework-GameController==6.2.2 +pyobjc-framework-GameKit==6.2.2 +pyobjc-framework-GameplayKit==6.2.2 +pyobjc-framework-IMServicePlugIn==6.2.2 +pyobjc-framework-IOSurface==6.2.2 +pyobjc-framework-ImageCaptureCore==6.2.2 +pyobjc-framework-InputMethodKit==6.2.2 +pyobjc-framework-InstallerPlugins==6.2.2 +pyobjc-framework-InstantMessage==6.2.2 +pyobjc-framework-Intents==6.2.2 +pyobjc-framework-InterfaceBuilderKit==6.2.2 +pyobjc-framework-LatentSemanticMapping==6.2.2 +pyobjc-framework-LaunchServices==6.2.2 +pyobjc-framework-LinkPresentation==6.2.2 +pyobjc-framework-LocalAuthentication==6.2.2 +pyobjc-framework-MapKit==6.2.2 +pyobjc-framework-MediaAccessibility==6.2.2 +pyobjc-framework-MediaLibrary==6.2.2 +pyobjc-framework-MediaPlayer==6.2.2 +pyobjc-framework-MediaToolbox==6.2.2 +pyobjc-framework-Message==6.2.2 +pyobjc-framework-Metal==6.2.2 +pyobjc-framework-MetalKit==6.2.2 +pyobjc-framework-ModelIO==6.2.2 +pyobjc-framework-MultipeerConnectivity==6.2.2 +pyobjc-framework-NaturalLanguage==6.2.2 +pyobjc-framework-NetFS==6.2.2 +pyobjc-framework-Network==6.2.2 +pyobjc-framework-NetworkExtension==6.2.2 +pyobjc-framework-NotificationCenter==6.2.2 +pyobjc-framework-OSAKit==6.2.2 +pyobjc-framework-OSLog==6.2.2 +pyobjc-framework-OpenDirectory==6.2.2 +pyobjc-framework-PencilKit==6.2.2 +pyobjc-framework-Photos==6.2.2 +pyobjc-framework-PhotosUI==6.2.2 +pyobjc-framework-PreferencePanes==6.2.2 +pyobjc-framework-PubSub==6.2.2 +pyobjc-framework-PushKit==6.2.2 +pyobjc-framework-QTKit==6.2.2 +pyobjc-framework-Quartz==6.2.2 +pyobjc-framework-QuickLookThumbnailing==6.2.2 +pyobjc-framework-SafariServices==6.2.2 +pyobjc-framework-SceneKit==6.2.2 +pyobjc-framework-ScreenSaver==6.2.2 +pyobjc-framework-ScriptingBridge==6.2.2 +pyobjc-framework-SearchKit==6.2.2 +pyobjc-framework-Security==6.2.2 +pyobjc-framework-SecurityFoundation==6.2.2 +pyobjc-framework-SecurityInterface==6.2.2 +pyobjc-framework-ServerNotification==6.2.2 +pyobjc-framework-ServiceManagement==6.2.2 +pyobjc-framework-Social==6.2.2 +pyobjc-framework-SoundAnalysis==6.2.2 +pyobjc-framework-Speech==6.2.2 +pyobjc-framework-SpriteKit==6.2.2 +pyobjc-framework-StoreKit==6.2.2 +pyobjc-framework-SyncServices==6.2.2 +pyobjc-framework-SystemConfiguration==6.2.2 +pyobjc-framework-SystemExtensions==6.2.2 +pyobjc-framework-UserNotifications==6.2.2 +pyobjc-framework-VideoSubscriberAccount==6.2.2 +pyobjc-framework-VideoToolbox==6.2.2 +pyobjc-framework-Vision==6.2.2 +pyobjc-framework-WebKit==6.2.2 +pyobjc-framework-XgridFoundation==6.2.2 +pyobjc-framework-iTunesLibrary==6.2.2 +pyobjc-framework-libdispatch==6.2.2 diff --git a/requirements/static/pkg/py3.8/freebsd.txt b/requirements/static/pkg/py3.8/freebsd.txt index 00e16ed9733..14f7f5d4929 100644 --- a/requirements/static/pkg/py3.8/freebsd.txt +++ b/requirements/static/pkg/py3.8/freebsd.txt @@ -11,9 +11,11 @@ chardet==3.0.4 # via requests cheroot==6.5.4 # via cherrypy cherrypy==17.4.1 contextlib2==0.5.5 # via cherrypy +contextvars==2.4 cryptography==3.3.2 # via pyopenssl distro==1.5.0 idna==2.8 # via requests +immutables==0.15 # via contextvars jaraco.functools==2.0 # via tempora jinja2==2.10.1 markupsafe==1.1.1 diff --git a/requirements/static/pkg/py3.8/linux.txt b/requirements/static/pkg/py3.8/linux.txt index 9ec6fabd393..575728c667b 100644 --- a/requirements/static/pkg/py3.8/linux.txt +++ b/requirements/static/pkg/py3.8/linux.txt @@ -11,9 +11,11 @@ chardet==3.0.4 # via requests cheroot==6.5.4 # via cherrypy cherrypy==17.4.1 contextlib2==0.5.5 # via cherrypy +contextvars==2.4 cryptography==3.3.2 # via pyopenssl distro==1.5.0 idna==2.8 # via requests +immutables==0.15 # via contextvars jaraco.functools==2.0 # via tempora jinja2==2.10.1 markupsafe==1.1.1 diff --git a/requirements/static/pkg/py3.9/darwin.txt b/requirements/static/pkg/py3.9/darwin.txt index 8be4462918e..0f4cbee9aff 100644 --- a/requirements/static/pkg/py3.9/darwin.txt +++ b/requirements/static/pkg/py3.9/darwin.txt @@ -2,7 +2,7 @@ # This file is autogenerated by pip-compile # To update, run: # -# pip-compile -o requirements/static/pkg/py3.9/darwin.txt -v requirements/darwin.txt requirements/static/pkg/darwin.in +# pip-compile -o requirements/static/pkg/py3.9/darwin.txt -v requirements/darwin.txt requirements/pyobjc.txt requirements/static/pkg/darwin.in # apache-libcloud==2.5.0 certifi==2020.6.20 # via requests @@ -11,11 +11,13 @@ chardet==3.0.4 # via requests cheroot==8.3.0 # via cherrypy cherrypy==17.4.1 contextlib2==0.6.0.post1 # via cherrypy +contextvars==2.4 cryptography==3.3.2 distro==1.5.0 gitdb==4.0.5 # via gitpython gitpython==3.1.12 idna==2.8 +immutables==0.15 # via contextvars jaraco.functools==2.0 # via cheroot, tempora jinja2==2.10.1 linode-python==1.1.1 @@ -43,5 +45,124 @@ timelib==0.2.5 urllib3==1.24.3 # via requests vultr==1.0.1 zc.lockfile==2.0 # via cherrypy -# Passthrough dependencies from requirements/darwin.txt +# Passthrough dependencies from requirements/pyobjc.txt pyobjc==6.2.2 +pyobjc-core==6.2.2 +pyobjc-framework-AVFoundation==6.2.2 +pyobjc-framework-AVKit==6.2.2 +pyobjc-framework-Accounts==6.2.2 +pyobjc-framework-AdSupport==6.2.2 +pyobjc-framework-AddressBook==6.2.2 +pyobjc-framework-AppleScriptKit==6.2.2 +pyobjc-framework-AppleScriptObjC==6.2.2 +pyobjc-framework-ApplicationServices==6.2.2 +pyobjc-framework-AuthenticationServices==6.2.2 +pyobjc-framework-AutomaticAssessmentConfiguration==6.2.2 +pyobjc-framework-Automator==6.2.2 +pyobjc-framework-BusinessChat==6.2.2 +pyobjc-framework-CFNetwork==6.2.2 +pyobjc-framework-CalendarStore==6.2.2 +pyobjc-framework-CloudKit==6.2.2 +pyobjc-framework-Cocoa==6.2.2 +pyobjc-framework-Collaboration==6.2.2 +pyobjc-framework-ColorSync==6.2.2 +pyobjc-framework-Contacts==6.2.2 +pyobjc-framework-ContactsUI==6.2.2 +pyobjc-framework-CoreAudio==6.2.2 +pyobjc-framework-CoreAudioKit==6.2.2 +pyobjc-framework-CoreBluetooth==6.2.2 +pyobjc-framework-CoreData==6.2.2 +pyobjc-framework-CoreHaptics==6.2.2 +pyobjc-framework-CoreLocation==6.2.2 +pyobjc-framework-CoreML==6.2.2 +pyobjc-framework-CoreMedia==6.2.2 +pyobjc-framework-CoreMediaIO==6.2.2 +pyobjc-framework-CoreMotion==6.2.2 +pyobjc-framework-CoreServices==6.2.2 +pyobjc-framework-CoreSpotlight==6.2.2 +pyobjc-framework-CoreText==6.2.2 +pyobjc-framework-CoreWLAN==6.2.2 +pyobjc-framework-CryptoTokenKit==6.2.2 +pyobjc-framework-DVDPlayback==6.2.2 +pyobjc-framework-DeviceCheck==6.2.2 +pyobjc-framework-DictionaryServices==6.2.2 +pyobjc-framework-DiscRecording==6.2.2 +pyobjc-framework-DiscRecordingUI==6.2.2 +pyobjc-framework-DiskArbitration==6.2.2 +pyobjc-framework-EventKit==6.2.2 +pyobjc-framework-ExceptionHandling==6.2.2 +pyobjc-framework-ExecutionPolicy==6.2.2 +pyobjc-framework-ExternalAccessory==6.2.2 +pyobjc-framework-FSEvents==6.2.2 +pyobjc-framework-FileProvider==6.2.2 +pyobjc-framework-FileProviderUI==6.2.2 +pyobjc-framework-FinderSync==6.2.2 +pyobjc-framework-GameCenter==6.2.2 +pyobjc-framework-GameController==6.2.2 +pyobjc-framework-GameKit==6.2.2 +pyobjc-framework-GameplayKit==6.2.2 +pyobjc-framework-IMServicePlugIn==6.2.2 +pyobjc-framework-IOSurface==6.2.2 +pyobjc-framework-ImageCaptureCore==6.2.2 +pyobjc-framework-InputMethodKit==6.2.2 +pyobjc-framework-InstallerPlugins==6.2.2 +pyobjc-framework-InstantMessage==6.2.2 +pyobjc-framework-Intents==6.2.2 +pyobjc-framework-InterfaceBuilderKit==6.2.2 +pyobjc-framework-LatentSemanticMapping==6.2.2 +pyobjc-framework-LaunchServices==6.2.2 +pyobjc-framework-LinkPresentation==6.2.2 +pyobjc-framework-LocalAuthentication==6.2.2 +pyobjc-framework-MapKit==6.2.2 +pyobjc-framework-MediaAccessibility==6.2.2 +pyobjc-framework-MediaLibrary==6.2.2 +pyobjc-framework-MediaPlayer==6.2.2 +pyobjc-framework-MediaToolbox==6.2.2 +pyobjc-framework-Message==6.2.2 +pyobjc-framework-Metal==6.2.2 +pyobjc-framework-MetalKit==6.2.2 +pyobjc-framework-ModelIO==6.2.2 +pyobjc-framework-MultipeerConnectivity==6.2.2 +pyobjc-framework-NaturalLanguage==6.2.2 +pyobjc-framework-NetFS==6.2.2 +pyobjc-framework-Network==6.2.2 +pyobjc-framework-NetworkExtension==6.2.2 +pyobjc-framework-NotificationCenter==6.2.2 +pyobjc-framework-OSAKit==6.2.2 +pyobjc-framework-OSLog==6.2.2 +pyobjc-framework-OpenDirectory==6.2.2 +pyobjc-framework-PencilKit==6.2.2 +pyobjc-framework-Photos==6.2.2 +pyobjc-framework-PhotosUI==6.2.2 +pyobjc-framework-PreferencePanes==6.2.2 +pyobjc-framework-PubSub==6.2.2 +pyobjc-framework-PushKit==6.2.2 +pyobjc-framework-QTKit==6.2.2 +pyobjc-framework-Quartz==6.2.2 +pyobjc-framework-QuickLookThumbnailing==6.2.2 +pyobjc-framework-SafariServices==6.2.2 +pyobjc-framework-SceneKit==6.2.2 +pyobjc-framework-ScreenSaver==6.2.2 +pyobjc-framework-ScriptingBridge==6.2.2 +pyobjc-framework-SearchKit==6.2.2 +pyobjc-framework-Security==6.2.2 +pyobjc-framework-SecurityFoundation==6.2.2 +pyobjc-framework-SecurityInterface==6.2.2 +pyobjc-framework-ServerNotification==6.2.2 +pyobjc-framework-ServiceManagement==6.2.2 +pyobjc-framework-Social==6.2.2 +pyobjc-framework-SoundAnalysis==6.2.2 +pyobjc-framework-Speech==6.2.2 +pyobjc-framework-SpriteKit==6.2.2 +pyobjc-framework-StoreKit==6.2.2 +pyobjc-framework-SyncServices==6.2.2 +pyobjc-framework-SystemConfiguration==6.2.2 +pyobjc-framework-SystemExtensions==6.2.2 +pyobjc-framework-UserNotifications==6.2.2 +pyobjc-framework-VideoSubscriberAccount==6.2.2 +pyobjc-framework-VideoToolbox==6.2.2 +pyobjc-framework-Vision==6.2.2 +pyobjc-framework-WebKit==6.2.2 +pyobjc-framework-XgridFoundation==6.2.2 +pyobjc-framework-iTunesLibrary==6.2.2 +pyobjc-framework-libdispatch==6.2.2 diff --git a/requirements/static/pkg/py3.9/freebsd.txt b/requirements/static/pkg/py3.9/freebsd.txt index b4b21699854..51bdcd4c1d6 100644 --- a/requirements/static/pkg/py3.9/freebsd.txt +++ b/requirements/static/pkg/py3.9/freebsd.txt @@ -11,9 +11,11 @@ chardet==3.0.4 # via requests cheroot==6.5.4 # via cherrypy cherrypy==17.4.1 contextlib2==0.5.5 # via cherrypy +contextvars==2.4 cryptography==3.3.2 # via pyopenssl distro==1.5.0 idna==2.8 # via requests +immutables==0.15 # via contextvars jaraco.functools==2.0 # via tempora jinja2==2.10.1 markupsafe==1.1.1 diff --git a/requirements/static/pkg/py3.9/linux.txt b/requirements/static/pkg/py3.9/linux.txt index 029c4b49643..07a44a89397 100644 --- a/requirements/static/pkg/py3.9/linux.txt +++ b/requirements/static/pkg/py3.9/linux.txt @@ -11,9 +11,11 @@ chardet==3.0.4 # via requests cheroot==6.5.4 # via cherrypy cherrypy==17.4.1 contextlib2==0.5.5 # via cherrypy +contextvars==2.4 cryptography==3.3.2 # via pyopenssl distro==1.5.0 idna==2.8 # via requests +immutables==0.15 # via contextvars jaraco.functools==2.0 # via tempora jinja2==2.10.1 markupsafe==1.1.1 diff --git a/requirements/tests.txt b/requirements/tests.txt deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/salt/loader.py b/salt/loader.py index 196ebeb0aa1..ddec8067b02 100644 --- a/salt/loader.py +++ b/salt/loader.py @@ -4,7 +4,6 @@ directories for python loadable code and organizes the code into the plugin interfaces used by Salt. """ -import contextvars import copy import functools import importlib @@ -45,6 +44,13 @@ from salt.template import check_render_pipe_str from salt.utils import entrypoints from salt.utils.decorators import Depends +try: + # Try the stdlib C extension first + import _contextvars as contextvars +except ImportError: + # Py<3.7 + import contextvars + log = logging.getLogger(__name__) SALT_BASE_PATH = os.path.abspath(salt.syspaths.INSTALL_DIR) diff --git a/salt/loader_context.py b/salt/loader_context.py index c0df778d1aa..cc45441c96b 100644 --- a/salt/loader_context.py +++ b/salt/loader_context.py @@ -3,9 +3,15 @@ Manage the context a module loaded by Salt's loader """ import collections.abc import contextlib -import contextvars import copy +try: + # Try the stdlib C extension first + import _contextvars as contextvars +except ImportError: + # Py<3.7 + import contextvars + DEFAULT_CTX_VAR = "loader_ctxvar" loader_ctxvar = contextvars.ContextVar(DEFAULT_CTX_VAR) diff --git a/salt/utils/thin.py b/salt/utils/thin.py index ae1bc01bb15..2b8e8b628c3 100644 --- a/salt/utils/thin.py +++ b/salt/utils/thin.py @@ -2,11 +2,13 @@ Generate the salt thin tarball from the installed python files """ -import contextvars +import contextvars as py_contextvars import copy +import importlib.util import logging import os import shutil +import site import subprocess import sys import tarfile @@ -93,6 +95,74 @@ else: log = logging.getLogger(__name__) +def import_module(name, path): + """ + Import a module from a specific path. Path can be a full or relative path + to a .py file. + + :name: The name of the module to import + :path: The path of the module to import + """ + try: + spec = importlib.util.spec_from_file_location(name, path) + except ValueError: + spec = None + if spec is not None: + lib = importlib.util.module_from_spec(spec) + try: + spec.loader.exec_module(lib) + except OSError: + pass + else: + return lib + + +def getsitepackages(): + """ + Some versions of Virtualenv ship a site.py without getsitepackages. This + method will first try and return sitepackages from the default site module + if no method exists we will try importing the site module from every other + path in sys.paths until we find a getsitepackages method to return the + results from. If for some reason no gesitepackages method can be found a + RuntimeError will be raised + + :return: A list containing all global site-packages directories. + """ + if hasattr(site, "getsitepackages"): + return site.getsitepackages() + for path in sys.path: + lib = import_module("site", os.path.join(path, "site.py")) + if hasattr(lib, "getsitepackages"): + return lib.getsitepackages() + raise RuntimeError("Unable to locate a getsitepackages method") + + +def find_site_modules(name): + """ + Finds and imports a module from site packages directories. + + :name: The name of the module to import + :return: A list of imported modules, if no modules are imported an empty + list is returned. + """ + libs = [] + site_paths = [] + try: + site_paths = getsitepackages() + except RuntimeError: + log.debug("No site package directories found") + for site_path in site_paths: + path = os.path.join(site_path, "{}.py".format(name)) + lib = import_module(name, path) + if lib: + libs.append(lib) + path = os.path.join(site_path, name, "__init__.py") + lib = import_module(name, path) + if lib: + libs.append(lib) + return libs + + def _get_salt_call(*dirs, **namespaces): """ Return salt-call source, based on configuration. @@ -364,8 +434,14 @@ def get_tops(extra_mods="", so_mods=""): ssl_match_hostname, markupsafe, backports_abc, - contextvars, ] + modules = find_site_modules("contextvars") + if modules: + contextvars = modules[0] + else: + contextvars = py_contextvars + log.debug("Using contextvars %r", contextvars) + mods.append(contextvars) if has_immutables: mods.append(immutables) for mod in mods: diff --git a/tests/filename_map.yml b/tests/filename_map.yml index 2ab584e825f..4a2a9175a8f 100644 --- a/tests/filename_map.yml +++ b/tests/filename_map.yml @@ -171,6 +171,7 @@ salt/(client/ssh/.+|cli/ssh\.py): - pytests.integration.ssh.test_pillar - integration.ssh.test_raw - integration.ssh.test_state + - pytests.integration.ssh.test_py_versions salt/config/*: - unit.test_config diff --git a/tests/pytests/conftest.py b/tests/pytests/conftest.py index d6cc6207598..6b1a0cd416d 100644 --- a/tests/pytests/conftest.py +++ b/tests/pytests/conftest.py @@ -75,6 +75,12 @@ def reactor_event(tmp_path_factory): shutil.rmtree(str(reactors_dir), ignore_errors=True) +@pytest.fixture(scope="session") +def master_id(): + master_id = random_string("master-") + yield master_id + + @pytest.fixture(scope="session") def salt_master_factory( request, @@ -89,8 +95,8 @@ def salt_master_factory( sdb_etcd_port, vault_port, reactor_event, + master_id, ): - master_id = random_string("master-") root_dir = salt_factories.get_root_dir_for_daemon(master_id) conf_dir = root_dir / "conf" conf_dir.mkdir(exist_ok=True) diff --git a/tests/pytests/integration/ssh/test_py_versions.py b/tests/pytests/integration/ssh/test_py_versions.py new file mode 100644 index 00000000000..55ff6bd7c43 --- /dev/null +++ b/tests/pytests/integration/ssh/test_py_versions.py @@ -0,0 +1,153 @@ +""" +Integration tests for salt-ssh py_versions +""" +import logging +import shutil +import subprocess + +import pytest +from saltfactories.factories.daemons.container import ContainerFactory +from saltfactories.utils import random_string +from saltfactories.utils.ports import get_unused_localhost_port + +docker = pytest.importorskip("docker") +from docker.errors import ( # isort:skip pylint: disable=3rd-party-module-not-gated + DockerException, +) + + +log = logging.getLogger(__name__) + +pytestmark = [ + pytest.mark.skip_if_binaries_missing("dockerd"), +] + + +class Keys: + """ + Temporary ssh key pair + """ + + def __init__(self, tmp_path_factory): + priv_path = tmp_path_factory.mktemp(".ssh") / "key" + self.priv_path = priv_path + + def generate(self): + subprocess.run( + ["ssh-keygen", "-q", "-N", "", "-f", str(self.priv_path)], check=True + ) + + @property + def pub_path(self): + return self.priv_path.with_name("{}.pub".format(self.priv_path.name)) + + @property + def pub(self): + return self.pub_path.read_text() + + @property + def priv(self): + return self.priv_path.read_text() + + def __enter__(self): + self.generate() + return self + + def __exit__(self, *_): + shutil.rmtree(str(self.priv_path.parent), ignore_errors=True) + + +@pytest.fixture(scope="module") +def docker_client(): + try: + client = docker.from_env() + except DockerException: + pytest.skip("Failed to get a connection to docker running on the system") + connectable = ContainerFactory.client_connectable(client) + if connectable is not True: # pragma: nocover + pytest.skip(connectable) + return client + + +@pytest.fixture(scope="module") +def ssh_keys(tmp_path_factory): + """ + Temporary ssh key fixture + """ + with Keys(tmp_path_factory) as keys: + yield keys + + +@pytest.fixture(scope="module") +def ssh_port(): + """ + Temporary ssh port fixture + """ + return get_unused_localhost_port() + + +@pytest.fixture(scope="module") +def salt_ssh_roster_file(ssh_port, ssh_keys, salt_master): + """ + Temporary roster for ssh docker container + """ + roster = """ + pyvertest: + host: localhost + user: centos + port: {} + priv: {} + ssh_options: + - StrictHostKeyChecking=no + - UserKnownHostsFile=/dev/null + """.format( + ssh_port, ssh_keys.priv_path + ) + with pytest.helpers.temp_file( + "py_versions_roster", roster, salt_master.config_dir + ) as roster_file: + yield roster_file + + +@pytest.fixture(scope="module") +def ssh_docker_container(salt_factories, docker_client, ssh_port, ssh_keys): + """ + Temporary docker container with python 3.6 and ssh enabled + """ + container = salt_factories.get_container( + random_string("ssh-py_versions-"), + "dwoz1/cicd:ssh", + docker_client=docker_client, + check_ports=[ssh_port], + container_run_kwargs={ + "ports": {"22/tcp": ssh_port}, + "environment": {"SSH_USER": "centos", "SSH_AUTHORIZED_KEYS": ssh_keys.pub}, + "cap_add": "IPC_LOCK", + }, + ) + with container.started() as factory: + yield factory + + +@pytest.fixture(scope="module") +def salt_ssh_cli(salt_master, salt_ssh_roster_file, ssh_keys, ssh_docker_container): + assert salt_master.is_running() + assert ssh_docker_container.is_running() + return salt_master.get_salt_ssh_cli( + default_timeout=180, + roster_file=salt_ssh_roster_file, + target_host="localhost", + client_key=str(ssh_keys.priv_path), + base_script_args=["--ignore-host-keys"], + ) + + +@pytest.mark.slow_test +def test_py36_target(salt_ssh_cli): + """ + Test that a python >3.6 master can salt ssh to a <3.6 target + """ + ret = salt_ssh_cli.run("test.ping", minion_tgt="pyvertest") + assert ret.exitcode == 0 + assert ret.json + assert ret.json is True diff --git a/tests/unit/grains/test_core.py b/tests/unit/grains/test_core.py index 2a9fa1613ed..fe2f31fede0 100644 --- a/tests/unit/grains/test_core.py +++ b/tests/unit/grains/test_core.py @@ -1247,9 +1247,9 @@ class CoreGrainsTestCase(TestCase, LoaderModuleMockMixin): with patch.dict( core.__salt__, {"cmd.run": MagicMock(return_value="")} ), patch.dict( - core.__salt__, {"cmd.run_all": MagicMock(return_value={"retcode": 0})} + core.__salt__, + {"cmd.run_all": MagicMock(return_value={"retcode": 0, "stdout": ""})}, ): - log.debug("Testing Xen") self.assertEqual( core._virtual({"kernel": "Linux"}).get("virtual_subtype"), "Xen PV DomU", diff --git a/tests/unit/utils/test_thin.py b/tests/unit/utils/test_thin.py index 66c68c396f7..091a6bf0c4f 100644 --- a/tests/unit/utils/test_thin.py +++ b/tests/unit/utils/test_thin.py @@ -433,7 +433,7 @@ class SSHThinTestCase(TestCase): type("concurrent", (), {"__file__": "/site-packages/concurrent"}), ) @patch( - "salt.utils.thin.contextvars", + "salt.utils.thin.py_contextvars", type("contextvars", (), {"__file__": "/site-packages/contextvars"}), ) @patch_if( @@ -448,24 +448,30 @@ class SSHThinTestCase(TestCase): :return: """ base_tops = [ - "/site-packages/distro", - "/site-packages/salt", - "/site-packages/jinja2", - "/site-packages/yaml", - "/site-packages/tornado", - "/site-packages/msgpack", - "/site-packages/certifi", - "/site-packages/sdp", - "/site-packages/sdp_hlp", - "/site-packages/ssl_mh", - "/site-packages/markupsafe", - "/site-packages/backports_abc", - "/site-packages/concurrent", - "/site-packages/contextvars", + "distro", + "salt", + "jinja2", + "yaml", + "tornado", + "msgpack", + "certifi", + "sdp", + "sdp_hlp", + "ssl_mh", + "markupsafe", + "backports_abc", + "concurrent", + "contextvars", ] if salt.utils.thin.has_immutables: - base_tops.extend(["/site-packages/immutables"]) - tops = thin.get_tops() + base_tops.extend(["immutables"]) + tops = [] + for top in thin.get_tops(extra_mods="foo,bar"): + if top.find("/") != -1: + spl = "/" + else: + spl = os.sep + tops.append(top.rsplit(spl, 1)[-1]) assert len(tops) == len(base_tops) assert sorted(tops) == sorted(base_tops), sorted(tops) @@ -520,7 +526,7 @@ class SSHThinTestCase(TestCase): type("concurrent", (), {"__file__": "/site-packages/concurrent"}), ) @patch( - "salt.utils.thin.contextvars", + "salt.utils.thin.py_contextvars", type("contextvars", (), {"__file__": "/site-packages/contextvars"}), ) @patch_if( @@ -535,33 +541,40 @@ class SSHThinTestCase(TestCase): :return: """ base_tops = [ - "/site-packages/distro", - "/site-packages/salt", - "/site-packages/jinja2", - "/site-packages/yaml", - "/site-packages/tornado", - "/site-packages/msgpack", - "/site-packages/certifi", - "/site-packages/sdp", - "/site-packages/sdp_hlp", - "/site-packages/ssl_mh", - "/site-packages/concurrent", - "/site-packages/markupsafe", - "/site-packages/backports_abc", - "/site-packages/contextvars", - os.sep + os.path.join("custom", "foo"), - os.sep + os.path.join("custom", "bar.py"), + "distro", + "salt", + "jinja2", + "yaml", + "tornado", + "msgpack", + "certifi", + "sdp", + "sdp_hlp", + "ssl_mh", + "concurrent", + "markupsafe", + "backports_abc", + "contextvars", + "foo", + "bar.py", ] if salt.utils.thin.has_immutables: - base_tops.extend(["/site-packages/immutables"]) - builtins = sys.version_info.major == 3 and "builtins" or "__builtin__" + base_tops.extend(["immutables"]) + libs = salt.utils.thin.find_site_modules("contextvars") foo = {"__file__": os.sep + os.path.join("custom", "foo", "__init__.py")} bar = {"__file__": os.sep + os.path.join("custom", "bar")} - with patch( - "{}.__import__".format(builtins), - MagicMock(side_effect=[type("foo", (), foo), type("bar", (), bar)]), - ): - tops = thin.get_tops(extra_mods="foo,bar") + with patch("salt.utils.thin.find_site_modules", MagicMock(side_effect=[libs])): + with patch( + "builtins.__import__", + MagicMock(side_effect=[type("foo", (), foo), type("bar", (), bar)]), + ): + tops = [] + for top in thin.get_tops(extra_mods="foo,bar"): + if top.find("/") != -1: + spl = "/" + else: + spl = os.sep + tops.append(top.rsplit(spl, 1)[-1]) self.assertEqual(len(tops), len(base_tops)) self.assertListEqual(sorted(tops), sorted(base_tops)) @@ -616,7 +629,7 @@ class SSHThinTestCase(TestCase): type("concurrent", (), {"__file__": "/site-packages/concurrent"}), ) @patch( - "salt.utils.thin.contextvars", + "salt.utils.thin.py_contextvars", type("contextvars", (), {"__file__": "/site-packages/contextvars"}), ) @patch_if( @@ -631,36 +644,43 @@ class SSHThinTestCase(TestCase): :return: """ base_tops = [ - "/site-packages/distro", - "/site-packages/salt", - "/site-packages/jinja2", - "/site-packages/yaml", - "/site-packages/tornado", - "/site-packages/msgpack", - "/site-packages/certifi", - "/site-packages/sdp", - "/site-packages/sdp_hlp", - "/site-packages/ssl_mh", - "/site-packages/concurrent", - "/site-packages/markupsafe", - "/site-packages/backports_abc", - "/site-packages/contextvars", - "/custom/foo.so", - "/custom/bar.so", + "distro", + "salt", + "jinja2", + "yaml", + "tornado", + "msgpack", + "certifi", + "sdp", + "sdp_hlp", + "ssl_mh", + "concurrent", + "markupsafe", + "backports_abc", + "contextvars", + "foo.so", + "bar.so", ] if salt.utils.thin.has_immutables: - base_tops.extend(["/site-packages/immutables"]) - builtins = sys.version_info.major == 3 and "builtins" or "__builtin__" - with patch( - "{}.__import__".format(builtins), - MagicMock( - side_effect=[ - type("salt", (), {"__file__": "/custom/foo.so"}), - type("salt", (), {"__file__": "/custom/bar.so"}), - ] - ), - ): - tops = thin.get_tops(so_mods="foo,bar") + base_tops.extend(["immutables"]) + libs = salt.utils.thin.find_site_modules("contextvars") + with patch("salt.utils.thin.find_site_modules", MagicMock(side_effect=[libs])): + with patch( + "builtins.__import__", + MagicMock( + side_effect=[ + type("salt", (), {"__file__": "/custom/foo.so"}), + type("salt", (), {"__file__": "/custom/bar.so"}), + ] + ), + ): + tops = [] + for top in thin.get_tops(so_mods="foo,bar"): + if top.find("/") != -1: + spl = "/" + else: + spl = os.sep + tops.append(top.rsplit(spl, 1)[-1]) assert len(tops) == len(base_tops) assert sorted(tops) == sorted(base_tops)