Salt Project

https://docs.saltproject.io/en/latest/
Admin
Salt is an event-driven automation engine for infrastructure management, configuration deployment,...
Tokens:2,110,955
Snippets:27,608
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Common Pip Installation Commands

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.pip.html

Standard usage examples for installing packages, using requirements files, and specifying virtual environments.

```bash
salt '*' pip.install <package name>,<package2 name>
salt '*' pip.install requirements=/path/to/requirements.txt
salt '*' pip.install <package name> bin_env=/path/to/virtualenv
salt '*' pip.install <package name> bin_env=/path/to/pip_bin
```

--------------------------------

### Install Package

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.zypperpkg.html

Installs a specified package. This example demonstrates installing a package by name. The `pkgs` parameter can be used to install multiple packages from a list.

```yaml
salt '*' pkg.install name=<package name>
```

--------------------------------

### Install Single or Multiple Packages

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.win_pkg.html

Provides examples for installing a single package, multiple packages using a comma-separated list, and multiple packages using a list in the `pkgs` argument.

```bash
salt '*' pkg.install 7zip
```

```bash
salt '*' pkg.install 7zip,filezilla
```

```bash
salt '*' pkg.install pkgs='["7zip","filezilla"]'
```

--------------------------------

### Install multiple packages via CLI

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.yumpkg.html

Examples of installing multiple packages, including specifying versions for individual packages.

```bash
salt '*' pkg.install pkgs='["foo", "bar"]'
salt '*' pkg.install pkgs='["foo", {"bar": "1.2.3-4.el5"}]'
```

--------------------------------

### Package Installation with List Context (2019.2.0+)

Source: https://docs.saltproject.io/en/latest/topics/releases/2019.2.0.html

This example shows how to correctly install packages when the package names are provided as a list or dictionary in the Salt state, using the `tojson` Jinja filter.

```yaml
grafana_packages:
  pkg.installed:
  - names: {{ server.pkgs|tojson }}

```

--------------------------------

### Install packages from sources via CLI

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.yumpkg.html

Example of installing specific RPM files from a URI or local path.

```bash
salt '*' pkg.install sources='[{"foo": "salt://foo.rpm"}, {"bar": "salt://bar.rpm"}]'
```

--------------------------------

### Install Multiple Packages via CLI

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.aptpkg.html

Examples of installing multiple packages using the pkgs argument in the Salt CLI.

```bash
salt '*' pkg.install pkgs='["foo", "bar"]'
salt '*' pkg.install pkgs='["foo", {"bar": "1.2.3-0ubuntu0"}]'
```

--------------------------------

### Example GET Request for Login

Source: https://docs.saltproject.io/en/latest/ref/netapi/all/salt.netapi.rest_tornado.html

Demonstrates how to make a GET request to the /login endpoint. This endpoint is parked and not intended for actual logins.

```bash
curl -i localhost:8000/login
```

```http
GET /login HTTP/1.1
Host: localhost:8000
Accept: application/json

```

--------------------------------

### Example repository file layout

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

A sample directory structure for a repository.

```text
.gitignore
README.txt
foo/
foo/bar/
foo/bar/one.txt
foo/bar/two.txt
foo/bar/three.txt
foo/baz/
foo/baz/top.sls
foo/baz/edit/vim.sls
foo/baz/edit/vimrc
foo/baz/nginx/init.sls
```

--------------------------------

### CLI Example: Get Package Version

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.win_pkg.html

Command-line interface examples for retrieving package versions using the salt command.

```bash
salt '*' pkg.version <package name>
salt '*' pkg.version <package name01> <package name02>
```

--------------------------------

### List Packages via CLI

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.aptpkg.html

Examples for listing installed packages using the Salt CLI.

```bash
salt '*' pkg.list_pkgs
salt '*' pkg.list_pkgs versions_as_list=True
```

--------------------------------

### Configure pkg.installed with advanced options

Source: https://docs.saltproject.io/en/latest/ref/states/all/salt.states.pkg.html

Example of installing a package with specific repository, version, and verification settings.

```yaml
httpd:
  pkg.installed:
    - fromrepo: mycustomrepo
    - skip_verify: True
    - skip_suggestions: True
    - version: 2.0.6~ubuntu3
    - refresh: True
    - allow_updates: True
    - hold: False
```

--------------------------------

### Install update using full Title

Source: https://docs.saltproject.io/en/latest/ref/states/all/salt.states.win_wua.html

This example illustrates installing an update by providing its full title string to the `name` parameter in the `wua.installed` state. Note that using partial titles or KB numbers can lead to unintended installations.

```yaml
install_update:
  wua.installed:
    - name: Security Update for Adobe Flash Player for Windows 10 Version 1607 (for x64-based Systems) (KB3194343)
```

--------------------------------

### List Repositories via CLI

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.aptpkg.html

Examples for listing configured APT repositories.

```bash
salt '*' pkg.list_repos
salt '*' pkg.list_repos disabled=True
```

--------------------------------

### Update RHEL Installation Guide

Source: https://docs.saltproject.io/en/latest/topics/releases/2015.8.8.html

Updates the RHEL installation guide to reflect recent repository changes and provides systemctl examples for RHEL 7.

```yaml
6370ddda9f Update RHEL installation guide
```

```yaml
afdaefbf3d Add systemctl examples for RHEL 7 to the installation guide
```

```yaml
069a661eb1 Correct ZeroMQ4 repo install guide for RHEL
```

```yaml
d2a9d67b5b Update installation instruction for community repos on RHEL
```

```yaml
bbdf2523c8 Add workaround for RHEL 7 systems mentioned in the issue #29094
```

--------------------------------

### Create a shortcut with parent directory creation

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.win_shortcut.html

This example shows how to create a shortcut and ensure that any necessary parent directories are created if they do not already exist. This simplifies deployment to deep directory structures.

```salt
salt '*' shortcut.create 'C:\path\to\shortcut.lnk' 'C:\Windows\notepad.exe' make_dirs=True
```

--------------------------------

### Uninstall Software Using MSI Installer

Source: https://docs.saltproject.io/en/latest/topics/windows/windows-package-manager.html

Example of uninstalling software by specifying the MSI installer path. This method is useful when the GUID is not readily available.

```yaml
7zip:
  '9.20.00.0':
    full_name: 7-Zip 9.20 (x64 edition)
    installer: salt://win/repo-ng/7zip/7z920-x64.msi
    install_flags: '/qn /norestart'
    uninstaller: salt://win/repo-ng/7zip/7z920-x64.msi
    uninstall_flags: '/qn /norestart'
    msiexec: True

```

--------------------------------

### Get all disabled services

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.debian_service.html

Returns a set of services that are installed but currently disabled from starting at boot. This helps identify services that are not set to start automatically.

```salt
salt '*' service.get_disabled
```

--------------------------------

### Require Requisite Example

Source: https://docs.saltproject.io/en/latest/ref/states/requisites.html

Standard 'require' requisite ensuring the httpd package is installed before the service starts.

```yaml
httpd:
  pkg.installed: []
  service.running:
    - require:
      - pkg: httpd
```

--------------------------------

### salt.proxy.dummy.service_start(_name_)

Source: https://docs.saltproject.io/en/latest/ref/proxy/all/salt.proxy.dummy.html

Start a "service" on the dummy server.

```APIDOC
## salt.proxy.dummy.service_start(_name_)

### Description
Start a "service" on the dummy server.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
APIDOC

### Request Example
APIDOC

### Response
APIDOC

### Response Example
APIDOC
```

--------------------------------

### Create a Webserver State File

Source: https://docs.saltproject.io/en/latest/topics/tutorials/states_pt1.html

Define a state file (e.g., `webserver.sls`) to manage the installation of a package. This example ensures the 'apache' package is installed using the `pkg` state.

```yaml
apache:
  pkg:
    - installed
```

--------------------------------

### Get Specific Windows Update Details

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.win_wua.html

Retrieves details for a specific Windows update by its name, GUID, or KB number. Can optionally download or install the update, and control whether to check online for updates.

```yaml
salt '*' win_wua.get name='12345678-abcd-1234-abcd-1234567890ab'
```

--------------------------------

### CLI Example: Initialize Git Repository

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.git.html

Example of how to initialize a Git repository using the Salt CLI.

```bash
salt myminion git.init /path/to/repo
```

--------------------------------

### Install multiple updates using list

Source: https://docs.saltproject.io/en/latest/ref/states/all/salt.states.win_wua.html

Demonstrates installing a collection of Windows updates by providing a list of their identifiers (KB numbers or GUIDs) to the `updates` parameter in the `wua.installed` state.

```yaml
install_updates:
  wua.installed:
    - updates:
      - KB3194343
      - 28cf1b09-2b1a-458c-9bd1-971d1b26b211
```

--------------------------------

### Get git config keys matching a key regex

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.git.html

Retrieves all values for git configuration keys that match a provided regular expression. This example specifically targets keys starting with 'user.' in the global configuration.

```bash
salt myminion git.config_get_regexp '^user\.' global=True
```

--------------------------------

### Install update using GUID

Source: https://docs.saltproject.io/en/latest/ref/states/all/salt.states.win_wua.html

Demonstrates installing a specific Windows update using its GUID as the identifier with the `wua.installed` state.

```yaml
install_update:
  wua.installed:
    - name: 28cf1b09-2b1a-458c-9bd1-971d1b26b211
```

--------------------------------

### List Repositories CLI Examples

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.yumpkg.html

Examples for listing configured YUM repositories.

```bash
salt '*' pkg.list_repos
salt '*' pkg.list_repos basedir=/path/to/dir
salt '*' pkg.list_repos basedir=/path/to/dir,/path/to/another/dir strict_config=False
```

--------------------------------

### CLI Example: Get Private Key Size

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.x509_v2.html

Example of how to use the x509.get_private_key_size function from the Salt CLI to get the size of a private key.

```bash
salt '*' x509.get_private_key_size /etc/pki/my.key
```

--------------------------------

### Get installed package information

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.aptpkg.html

Retrieve information about installed packages.

```bash
salt '*' pkg.info_installed <package1>
salt '*' pkg.info_installed <package1> <package2> <package3> ...
salt '*' pkg.info_installed <package1> failhard=false
```

--------------------------------

### salt.modules.dummyproxy_service.start

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.dummyproxy_service.html

Starts the specified service on the dummy proxy.

```APIDOC
## salt.modules.dummyproxy_service.start

### Description
Start the specified service on the dummy.

### Parameters
* **_name_** (string) - The name of the service to start.
* **_sig_** (string, optional) - Signature for the service.

### CLI Example
```
salt '*' service.start <service name>
```

### New in version
2016.11.3
```

--------------------------------

### Install Windows Updates

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.win_wua.html

Installs specified Windows updates. Updates can be identified by GUIDs, KB numbers, or names. It is recommended to use GUIDs or KBs for precise identification.

```salt
salt '*' win_wua.install KB12323211
```

--------------------------------

### List Folders CLI Example

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.vsphere.html

Example command to list folders on a vSphere host.

```bash
salt '*' vsphere.list_folders 1.2.3.4 root bad-password
```

--------------------------------

### enable

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.debian_service.html

Enable the named service to start at boot.

```APIDOC
## enable(_name_ , _** kwargs_)

### Description
Enable the named service to start at boot.

### Parameters
* **name** (_str_) -- The name of the service to enable.
* **kwargs** -- Additional keyword arguments.

### CLI Example
```
salt '*' service.enable <service name>
```
```

--------------------------------

### List Storage Policies CLI Examples

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.vsphere.html

Examples for listing all storage policies or specific ones by name.

```bash
salt '*' vsphere.list_storage_policies

salt '*' vsphere.list_storage_policies policy_names=[policy_name]
```

--------------------------------

### Get all installed services

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.smf_service.html

Returns a list or dictionary of all installed services on the system.

```APIDOC
## service.get_all

### Description
Return all installed services.

### CLI Example
```
salt '*' service.get_all
```
```

--------------------------------

### Example Return Data for list_pkgs

Source: https://docs.saltproject.io/en/latest/topics/development/package_providers.html

Illustrates the expected dictionary format for the `list_pkgs` function, where keys are package names and values are their installed versions.

```json
{"foo": "1.2.3-4", "bar": "5.6.7-8"}
```

--------------------------------

### Get Installed PostgreSQL Extension Info

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.postgres.html

Retrieves information about an installed PostgreSQL extension. Use this to verify installation and configuration.

```salt
salt '*' postgres.get_installed_extension plpgsql
```

--------------------------------

### Verify installed packages

Source: https://docs.saltproject.io/en/latest/ref/states/all/salt.states.pkg.html

Examples of using pkg_verify to ensure package integrity during installation.

```yaml
httpd:
  pkg.installed:
    - version: 2.2.15-30.el6.centos
    - pkg_verify: True
```

```yaml
mypkgs:
  pkg.installed:
    - pkgs:
      - foo
      - bar: 1.2.3-4
      - baz
    - pkg_verify:
      - ignore_types:
        - config
        - doc
```

```yaml
mypkgs:
  pkg.installed:
    - pkgs:
      - foo
      - bar: 1.2.3-4
      - baz
    - pkg_verify:
      - ignore_types:
        - config
        - doc
      - verify_options:
        - nodeps
        - nofiledigest
```

--------------------------------

### Install Salt with Easy Install and SetupTools

Source: https://docs.saltproject.io/en/latest/topics/development/hacking.html

Installs Salt using `easy_install`, ensuring dependencies are installed by defining the USE_SETUPTOOLS environment variable.

```bash
USE_SETUPTOOLS=1 easy_install salt
```

--------------------------------

### Example Repository File Structures

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

Illustrative file structures for multiple GitFS remotes.

```text
first.git:
    top.sls
    edit/vim.sls
    edit/vimrc
    nginx/init.sls
    shell/init.sls

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

third:
    haproxy/haproxy.conf
    edit/dev_vimrc
```

--------------------------------

### CLI Example for pkg.downloaded

Source: https://docs.saltproject.io/en/latest/ref/states/all/salt.states.pkg.html

Example usage of the pkg.downloaded state.

```yaml
zsh:
  pkg.downloaded:
    - version: 5.0.5-4.63
    - fromrepo: "myrepository"
```

--------------------------------

### Compare group packages

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.yumpkg.html

Examples for listing which packages in a group are installed versus not installed.

```bash
salt '*' pkg.group_diff 'Perl Support'
salt '*' pkg.group_diff 'Perl Support' fromrepo=base,updates
salt '*' pkg.group_diff 'Perl Support' enablerepo=somerepo
```

--------------------------------

### List SSDs CLI Examples

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.vsphere.html

Examples for listing SSDs on a single ESXi host or across a vCenter Server.

```bash
# Used for single ESXi host connection information
salt '*' vsphere.list_ssds my.esxi.host root bad-password

# Used for connecting to a vCenter Server
salt '*' vsphere.list_ssds my.vcenter.location root bad-password         host_names='[esxi-1.host.com, esxi-2.host.com]'
```

--------------------------------

### Uninstall Software Using GUID

Source: https://docs.saltproject.io/en/latest/topics/windows/windows-package-manager.html

Example of uninstalling software using its unique GUID. Ensure the GUID is correct for the target software.

```yaml
7zip:
  '9.20.00.0':
    full_name: 7-Zip 9.20 (x64 edition)
    installer: salt://win/repo-ng/7zip/7z920-x64.msi
    install_flags: '/qn /norestart'
    uninstaller: '{23170F69-40C1-2702-0920-000001000000}'
    uninstall_flags: '/qn /norestart'
    msiexec: True

```

--------------------------------

### Example libgit2 incompatibility error log

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

This log entry indicates an incompatible libgit2 package is installed.

```text
2017-02-15 18:04:45,211 [salt.utils.gitfs ][ERROR   ][6211] Error occurred fetching gitfs remote 'https://foo.com/bar.git': No Content-Type header in response
```

--------------------------------

### HTTP GET Request for Events

Source: https://docs.saltproject.io/en/latest/ref/netapi/all/salt.netapi.rest_tornado.html

An example of the HTTP GET request sent to the events endpoint.

```http
GET /events HTTP/1.1
Host: localhost:8000


```

--------------------------------

### CLI Example for Creating a Certificate

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.x509.html

This command-line example shows how to create a certificate using the x509.create_certificate function, specifying paths for the certificate, private key, and CSR.

```bash
salt '*' x509.create_certificate path=/etc/pki/myca.crt signing_private_key='/etc/pki/myca.key' csr='/etc/pki/myca.csr'}
```

--------------------------------

### Example pygit2 compilation error logs

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

These log entries indicate an incompatible python-pygit2 package installation.

```text
2017-02-10 09:07:34,892 [salt.utils.gitfs ][ERROR ][11211] Import pygit2 failed: CompileError: command 'gcc' failed with exit status 1
2017-02-10 09:07:34,907 [salt.utils.gitfs ][ERROR ][11211] gitfs is configured but could not be loaded, are pygit2 and libgit2 installed?
2017-02-10 09:07:34,907 [salt.utils.gitfs ][CRITICAL][11211] No suitable gitfs provider module is installed.
2017-02-10 09:07:34,912 [salt.master ][CRITICAL][11211] Master failed pre flight checks, exiting
```

--------------------------------

### Install pygit2 on Debian via Pypi

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

Install libgit2 and a specific version of pygit2 via salt-pip for onedir installations.

```bash
# apt-get install libgit2
# salt-pip install pygit2==1.6.1 --no-deps
```

--------------------------------

### Install git binary for gitcli provider

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

Install the system git package required for the gitcli provider.

```bash
# yum install git           # RHEL / Fedora / EPEL
# apt-get install git       # Debian / Ubuntu
```

--------------------------------

### Install pygit2 on Fedora/EPEL

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

Use this command to install the pygit2 package on Fedora or EPEL-based systems.

```bash
# yum install python-pygit2
```

--------------------------------

### Install GitPython on Debian-based systems

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

Use apt-get to install the python-git package on Ubuntu or Debian systems.

```bash
# apt-get install python-git
```

--------------------------------

### Saltcheck Test File Example

Source: https://docs.saltproject.io/en/latest/topics/releases/3000.html

An example of a Saltcheck test file written in YAML, demonstrating setup, conditional testing with Jinja, assertions, and skipping tests. The `saltcheck.state_apply` module is used for test setup.

```yaml
{# will run the common salt state before further testing #}
setup_test_environment:
  module_and_function: saltcheck.state_apply
  args:
    - common
  pillar-data:
    data: value

{% for package in ["apache2", "openssh"] %}
{# or another example #}
{# for package in salt['pillar.get']("packages") #}
jinja_test_{{ package }}_latest:
  module_and_function: pkg.upgrade_available
  args:
    - {{ package }}
  assertion: assertFalse
{% endfor %}

validate_user_present_and_shell:
  module_and_function: user.info
  args:
    - root
  assertion: assertEqual
  expected-return: /bin/bash
  assertion_section: shell
  print_result: False

skip_test:
  module_and_function: pkg.upgrade_available
  args:
    - apache2
  assertion: assertFalse
  skip: True

```

--------------------------------

### salt.resources.dummy.service_start

Source: https://docs.saltproject.io/en/latest/ref/resources/all/salt.resources.dummy.html

Starts a "service" on the current dummy resource.

```APIDOC
## salt.resources.dummy.service_start

### Description
Start a "service" on the current dummy resource.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **name** (str) - Required - The name of the service to start.

### Response
#### Success Response (200)
- **return_value** (None) - Indicates successful start.

### Request Example
```json
{
  "name": "example-service"
}
```

### Response Example
```json
null
```
```

--------------------------------

### Example top.sls with saltenv

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

Use the saltenv variable to dynamically map environments in the top file.

```yaml
{{ saltenv }}:
  '*':
    - mystuff
```

--------------------------------

### Example mystuff.sls state file

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

A sample state file managing a package, configuration file, and service.

```yaml
manage_mystuff:
  pkg.installed:
    - name: mystuff
  file.managed:
    - name: /etc/mystuff.conf
    - source: salt://mystuff/files/mystuff.conf
  service.running:
    - name: mystuffd
    - enable: True
    - watch:
      - file: /etc/mystuff.conf
```

--------------------------------

### Install pygit2 on Debian/Ubuntu

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

Use this command to install the pygit2 package on Debian or Ubuntu systems.

```bash
# apt-get install python-pygit2
```

--------------------------------

### salt.proxy.dummy.package_install(_name_, _**kwargs_)

Source: https://docs.saltproject.io/en/latest/ref/proxy/all/salt.proxy.dummy.html

Install a "package" on the REST server.

```APIDOC
## salt.proxy.dummy.package_install(_name_, _**kwargs_)

### Description
Install a "package" on the REST server.

### Method
APIDOC

### Endpoint
APIDOC

### Parameters
APIDOC

### Request Example
APIDOC

### Response
APIDOC

### Response Example
APIDOC
```

--------------------------------

### Get Package Version

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.pkgutil.html

Returns the installed version of a package. Returns an empty string if the package is not installed.

```salt
salt '*' pkgutil.version CSWpython
```

--------------------------------

### Install GitPython on RHEL-based systems

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

Use yum to install the GitPython package on RHEL-based Linux distributions.

```bash
# yum install GitPython
```

--------------------------------

### Install compatible GitPython for Python 2.6

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

Use a Salt SLS state to install a version of GitPython compatible with Python 2.6.

```yaml
GitPython:
  pip.installed:
    - name: 'GitPython < 2.0.9'
```

--------------------------------

### Install Single Package with Refresh

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.win_pkg.html

This example refreshes the winrepo cache and then installs the '7zip' package. The `refresh=True` argument ensures that the package metadata is up-to-date before installation.

```bash
salt '*' pkg.install 7zip refresh=True
```

--------------------------------

### Configure GitFS Remotes with Per-remote Parameters

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

Example configuration showing how to define global settings and override them for specific gitfs remotes using a colon suffix for the URL.

```yaml
gitfs_provider: pygit2
gitfs_base: develop

gitfs_remotes:
  - https://foo.com/foo.git
  - https://foo.com/bar.git:
    - root: salt
    - mountpoint: salt://bar
    - base: salt-base
    - ssl_verify: False
    - update_interval: 120
  - https://foo.com/bar.git:
    - name: second_bar_repo
    - root: other/salt
    - mountpoint: salt://other/bar
    - base: salt-base
    - ref_types:
      - branch
  - http://foo.com/baz.git:
    - root: salt/states
    - user: joe
    - password: mysupersecretpassword
    - insecure_auth: True
    - disable_saltenv_mapping: True
    - saltenv:
      - foo:
        - ref: foo
  - http://foo.com/quux.git:
    - all_saltenvs: master
```

--------------------------------

### Build and Preview Salt Documentation Locally

Source: https://docs.saltproject.io/en/latest/topics/development/contributing.html

Builds the Salt documentation using nox, opens it in a web browser, and starts a local HTTP server. This command is used for the initial build.

```bash
python -m nox -e 'docs-html(compress=False, clean=False)'; cd doc/_build/html; python -m webbrowser http://localhost:8000/contents.html; python -m http.server

```

--------------------------------

### CLI Example for locate.version

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.locate.html

Example of how to use the locate.version function from the Salt command line.

```bash
salt '*' locate.version
```

--------------------------------

### Cache Entire Directory for Installer

Source: https://docs.saltproject.io/en/latest/topics/windows/windows-package-manager.html

Example of using `cache_dir: True` to cache the entire directory containing the installer. This is beneficial for installers that rely on other files within the same directory.

```yaml
sqlexpress:
  '12.0.2000.8':
    full_name: Microsoft SQL Server 2014 Setup (English)
    installer: 'salt://win/repo/sqlexpress/setup.exe'
    install_flags: '/ACTION=install /IACCEPTSQLSERVERLICENSETERMS /Q'
    cache_dir: True

```

--------------------------------

### Example state compilation error

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

Output showing conflicting state IDs when multiple environments are included in a highstate.

```text
myminion:
    Data failed to compile:
----------
    Detected conflicting IDs, SLS IDs need to be globally unique.
    The conflicting ID is 'manage_mystuff' and is found in SLS 'base:mystuff' and SLS 'dev:mystuff'
----------
    Detected conflicting IDs, SLS IDs need to be globally unique.
    The conflicting ID is 'manage_mystuff' and is found in SLS 'dev:mystuff' and SLS 'qa:mystuff'
```

--------------------------------

### Install Multiple Python Packages

Source: https://docs.saltproject.io/en/latest/ref/states/all/salt.states.pip_state.html

Installs multiple Python packages simultaneously, specifying version constraints for each. This example installs Django and psycopg2 with their respective version requirements.

```yaml
django-and-psycopg2:
  pip.installed:
    - pkgs:
      - django >= 1.6, <= 1.7
      - psycopg2 >= 2.8.4
    - require:
      - pkg: python-pip
```

--------------------------------

### Start release notes file for 2015.8.12

Source: https://docs.saltproject.io/en/latest/topics/releases/2015.8.12.html

Initializes the release notes file for the 2015.8.12 version.

```yaml
PR #35043: (rallytime) Start release notes file for 2015.8.12 @ _2016-08-01 17:22:04 UTC_
```

```yaml
343576408f Merge pull request #35043 from rallytime/new-release-notes
```

```yaml
bdcc81a384 Start release notes file for 2015.8.12
```

--------------------------------

### salt.modules.win_license.install

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.win_license.html

Installs the given product key using the slmgr.vbs script.

```APIDOC
## install(_product_key_)

### Description
Installs the given product key.

### Method
`salt '*'

### Endpoint
`license.install`

### Parameters
#### Path Parameters
- **product_key** (str) - Required - The product key to install.

### CLI Example
```
salt '*' license.install XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
```

### Returns
The output of the `slmgr.vbs` script.

### Return type
str
```

--------------------------------

### Install IIS with dsc_resource

Source: https://docs.saltproject.io/en/latest/ref/states/all/salt.states.win_dsc_resource.html

Example of installing IIS using the `dsc_resource.managed` state. This ensures the 'Web-Server' Windows feature is present.

```yaml
install_iis:
  dsc_resource.managed:
    - name: WindowsFeature
    - module_name: PSDesiredStateConfiguration
    - properties:
        Name: Web-Server
        Ensure: Present
```

--------------------------------

### Define GitFS branch names

Source: https://docs.saltproject.io/en/latest/topics/tutorials/gitfs.html

List of branch names used to represent environments in a typical setup.

```text
master
qa
dev
```

--------------------------------

### List vApps CLI Example

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.vsphere.html

Example of listing vApps for a specified host.

```bash
# List vapps from all minions
salt '*' vsphere.list_vapps 1.2.3.4 root bad-password
```

--------------------------------

### List Licenses CLI Example

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.vsphere.html

Example command to list all licenses on a vCenter.

```bash
salt '*' vsphere.list_licenses
```

--------------------------------

### Get Git Version

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.git.html

Retrieves the version of Git installed on the minion. Set `_versioninfo` to `True` to get the version as a list.

```salt
salt myminion git.version
```

--------------------------------

### up

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.rh_ip.html

Start up a network interface.

```APIDOC
## up

### Description
Start up a network interface.

### Method
`salt`

### Endpoint
`ip.up`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **iface** (string) - Required - The name of the network interface.
* **iface_type** (string) - Required - The type of the interface.

### Request Example
```
salt '*' ip.up eth0
```

### Response
#### Success Response (200)
Details about the success response are not provided in the source.
```

--------------------------------

### Complete Example in etc/salt/master

Source: https://docs.saltproject.io/en/latest/ref/pillar/all/salt.pillar.extra_minion_data_in_pillar.html

This example shows how to configure the `extra_minion_data_in_pillar` in `/etc/salt/master` to include all keys in the pillar.

```yaml
ext_pillar:
  - extra_minion_data_in_pillar:
      include: *

```

--------------------------------

### Get Installed Applications with OSQuery

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.osquery.html

Retrieves a list of installed applications from OSQuery. This is useful for software inventory and compliance checks.

```salt
salt '*' osquery.apps
```

--------------------------------

### Install Apache and ensure it is running

Source: https://docs.saltproject.io/en/latest/topics/tutorials/states_pt2.html

This snippet installs the Apache package and ensures the Apache service is running. It uses a 'require' requisite to ensure the package is installed before starting the service.

```yaml
1apache:
2  pkg.installed: []
3  service.running:
4    - require:
5      - pkg: apache

```

--------------------------------

### bootstrap

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.win_psget.html

Ensure that nuget-anycpu.exe is installed by downloading it from the internet.

```APIDOC
## bootstrap

### Description
Make sure that nuget-anycpu.exe is installed. This will download the official nuget-anycpu.exe from the internet.

### CLI Example
```
salt 'win01' psget.bootstrap
```
```

--------------------------------

### Configure MSI Installation with msiexec Path

Source: https://docs.saltproject.io/en/latest/topics/windows/windows-package-manager.html

Example demonstrating how to configure an MSI installation by explicitly providing the path to `msiexec.exe`. This ensures Salt uses the correct executable for installation and uninstallation.

```yaml
7zip:
  '9.20.00.0':
    full_name: 7-Zip 9.20 (x64 edition)
    installer: salt://win/repo/7zip/7z920-x64.msi
    install_flags: '/qn /norestart'
    uninstaller: salt://win/repo/7zip/7z920-x64.msi
    uninstall_flags: '/qn /norestart'
    msiexec: 'C:\\Windows\\System32\\msiexec.exe'

```

--------------------------------

### Login and Authentication Example

Source: https://docs.saltproject.io/en/latest/topics/releases/saltapi/0.8.0.html

Demonstrates how to log in to the Salt API and retrieve authentication token and permissions. Requires Salt 0.13.

```bash
% curl -sS localhost:8000/login \
    -H 'Accept: application/x-yaml'
    -d username='saltdev'
    -d password='saltdev'
    -d eauth='pam'

return:
  - eauth: pam
    expire: 1365508324.359403
    perms:
      - '@wheel'
      - grains.*
      - state.*
      - status.*
      - sys.*
      - test.*
    start: 1365465124.359402
    token: caa7aa2b9dbc4a8adb6d2e19c3e52be68995ef4b
    user: saltdev


```

--------------------------------

### Get the latest installed kernel version

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.kernelpkg_linux_apt.html

Returns the version of the latest kernel that is currently installed on the system. Note that this may differ from the active kernel if a reboot has not yet occurred after an installation.

```salt
salt '*' kernelpkg.latest_installed
```

--------------------------------

### salt.modules.debian_ip.up

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.debian_ip.html

Start up a network interface.

```APIDOC
## salt.modules.debian_ip.up

### Description
Start up a network interface.

### Method
Salt

### Function
up

### Parameters
#### Arguments
* **iface** (*str) - The name of the interface.
* **iface_type** (*str) - The type of the interface (e.g., 'eth').

### CLI Example
```
salt '*' ip.up eth0 eth
```
```

--------------------------------

### Verify Packages CLI Examples

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.zypperpkg.html

Illustrates how to verify installed packages using the `pkg.verify` command, with options to specify packages and ignore certain file types.

```bash
salt '*' pkg.verify
```

```bash
salt '*' pkg.verify httpd
```

```bash
salt '*' pkg.verify 'httpd postfix'
```

```bash
salt '*' pkg.verify 'httpd postfix' ignore_types=['config','doc']
```

--------------------------------

### Version Check Example

Source: https://docs.saltproject.io/en/latest/ref/states/all/salt.states.macpackage.html

An example demonstrating how to specify a version check for a package installation. The version number can utilize regular expressions.

```yaml
version_check: python --version_check=2.7.[0-9]
```

--------------------------------

### Install Package with Normalization Disabled

Source: https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.yumpkg.html

Example of installing a package while disabling name normalization to handle specific package naming conventions.

```bash
salt -G role:nsd pkg.install gpfs.gplbin-2.6.32-279.31.1.el6.x86_64 normalize=False
```

--------------------------------

### Example Windows Update Policy Configuration

Source: https://docs.saltproject.io/en/latest/ref/states/all/salt.states.win_lgpo.html

This example demonstrates how to write a Salt state file to configure Windows Update settings. It shows the structure required for the `lgpo.set` state, including nested policy settings.

```yaml
configure_windows_update_settings:
  lgpo.set:
    - computer_policy:
        Configure Automatic Updates:
          Configure automatic updating: 3 - Auto download and notify for install
          Install during automatic maintenance: False
          Install updates for other Microsoft products: False
          Scheduled install day: 0 - Every day
          Scheduled install time: 03:00
```
Tokens:
Raw