win_chocolatey – Управление пакетами с помощью Chocolatey
Описание
- Управление пакетами с помощью Chocolatey.
- Если Chocolatey отсутствует в системе, модуль его установит.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- chocolatey >= 0.10.5 (будет обновлён, если версия старая)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| allow_empty_checksums boolean добавлен в 2.2 |
| Разрешить использование пустых контрольных сумм для загруженных ресурсов из небезопасных мест. Используйте win_chocolatey_feature с именем allowEmptyChecksums для управления этим параметром глобально. |
| allow_multiple boolean добавлен в 2.8 |
| Разрешить установку нескольких пакетов, когда указана версия. Наличие нескольких пакетов с разными версиями может вызвать проблемы, если пакет не поддерживает это. Используйте на свой страх и риск. |
| allow_prerelease boolean добавлен в 2.6 |
| Разрешить установку предварительных версий пакетов. Если значение состояния равно latest, будет установлена последняя предварительная версия пакета. |
| architecture строка добавлен в 2.7 |
| Принудительно устанавливать пакет Chocolatey определенной архитектуры процессора. При установке значения x86, гарантируется, что Chocolatey установит пакет x86, даже если операционная система 64-разрядная. |
| force boolean |
| Принудительно устанавливает пакет, даже если он уже установлен. Использование параметра force заставит Ansible всегда сообщать о внесенных изменениях. |
| ignore_checksums boolean добавлен в 2.2 |
| Игнорировать предоставленные контрольные суммы пакета. Используйте win_chocolatey_feature с именем checksumFiles для управления этим параметром глобально. |
| ignore_dependencies boolean добавлен в 2.1 |
| Игнорировать зависимости, устанавливать/обновлять только сам пакет. |
| install_args строка добавлен в 2.1 | Аргументы для передачи нативный установщику. Это аргументы, которые передаются непосредственно установщику пакета Chocolatey. Как правило, это расширенный параметр. | |
| name список / обязательно | Имя пакета(ов), который(е) необходимо установить. Установите значение all, чтобы выполнить действие для всех установленных пакетов. | |
| package_params строка добавлен в 2.1 | Параметры для передачи пакету. Это параметры, специфичные для пакета Chocolatey, и обычно документируются самим пакетом. До Ansible 2.7 этот параметр был просто params. псевдонимы: params | |
| pinned boolean добавлен в 2.8 |
| Фиксировать пакет Chocolatey или нет. Если опущено, то проверки на фиксацию пакетов не выполняются. Будет фиксировать/отменять фиксацию конкретной версии, если установлена версия version. Будет фиксировать последнюю версию пакета, если yes, version не задана, и нет закрепления.Отменит закрепление всех версий пакета, если no и version не задано.Это игнорируется, если state=absent. |
| proxy_password строка добавлен в 2.4 | Пароль прокси-сервера, используемый для установки Chocolatey и пакета. Это значение представлено в качестве аргумента команды, и любой учетной записи с привилегиями доступно это значение при запуске модуля Chocolatey. Определите пароль на уровне глобальной конфигурации с помощью win_chocolatey_config с именем proxyPassword, чтобы избежать этого. | |
| proxy_url строка добавлен в 2.4 | URL-адрес прокси-сервера, используемый для установки Chocolatey и пакета. Используйте win_chocolatey_config с именем proxy для управления этим параметром глобально. | |
| proxy_username строка добавлен в 2.4 | Имя пользователя прокси-сервера, используемое для установки Chocolatey и пакета. До Ansible 2.7 пользователям с символами двойных кавычек " необходимо было экранировать \ заранее. Теперь это больше не требуется.Используйте win_chocolatey_config с именем proxyUser для управления этим параметром глобально. | |
| skip_scripts boolean добавлен в 2.4 |
| Не запускать скрипты chocolateyInstall.ps1 или chocolateyUninstall.ps1 при установке пакета. |
| source строка | Укажите источник для получения пакета. Используйте win_chocolatey_source для управления глобальными источниками. Это значение может быть URL-адресом Chocolatey-фида, путем к папке, содержащей пакеты .nupkg, или именем источника, определенным с помощью win_chocolatey_source.Это значение также используется, когда Chocolatey не установлен, в качестве расположения скрипта install.ps1, и в этом случае поддерживаются только URL-адреса. | |
| source_password строка добавлен в 2.7 | Пароль для source_username. Это значение представлено в качестве аргумента команды, и любой учетной записи с привилегиями доступно это значение при запуске модуля Chocolatey. Определите учетные данные с помощью источника с win_chocolatey_source, чтобы избежать этого. | |
| source_username строка добавлен в 2.7 | Имя пользователя, используемое с source при доступе к фиду, требующему аутентификацию. Рекомендуется определить учетные данные в источнике с win_chocolatey_source вместо передачи их по каждой задаче. | |
| state строка |
| Состояние пакета в системе. Когда absent, гарантируется, что пакет не установлен.Когда present, гарантируется установка пакета.Когда downgrade, позволяет Chocolatey понизить версию пакета, если version старше установленной версии.Когда latest, гарантируется установка пакета до последней доступной версии.Когда reinstalled, удалит и переустановит пакет. |
| timeout целое число добавлен в 2.3 | Значение по умолчанию: 2700 | Время, отведенное на завершение работы Chocolatey, прежде чем произойдет таймаут. псевдонимы: execution_timeout |
| validate_certs boolean добавлено в 2.7 |
| Используется при загрузке скрипта установки Chocolatey, если Chocolatey еще не установлен, это не влияет на процесс установки пакета Chocolatey. Когда no, сертификаты SSL не будут проверяться.Это следует использовать только на сайтах, контролируемых вами лично, использующих самозаверенный сертификат. |
| version строка | Конкретная версия пакета для установки. Когда state установлен на absent, будет удалена конкретная версия, в противном случае будут удалены все версии этого пакета.Если установлена другая версия пакета, state должен быть latest или force установлен на yes для установки желаемой версии.Укажите в виде строки (например, '6.1'), в противном случае она считается числом с плавающей запятой, и в зависимости от локали может быть преобразована в 6,1, что приведет к ошибке.Если name установлен на chocolatey и Chocolatey не установлен на хосте, это будет версия Chocolatey, которая будет установлена. Также можно установить переменную среды chocolateyVersion. |
Примечания
Примечание
- Этот модуль будет устанавливать или обновлять Chocolatey при необходимости.
- При использовании уровня подробности 2 или меньше (
-vv) выводstdoutбудет ограничен. При использовании уровня подробности 4 (-vvvv) выводstdoutбудет более подробным. При использовании уровня подробности 5 (-vvvvv) выводstdoutбудет включать отладочную информацию. - Для установки некоторых пакетов, таких как исправления или обновления, требуется интерактивный вход пользователя. Для этого можно использовать
become, см. Become и Windows. Даже если вы подключаетесь как локальный администратор, использованиеbecomeдля получения прав администратора предоставит вам интерактивный вход пользователя, см. примеры ниже. - Если
becomeнедоступен, используйте win_hotfix для установки исправлений вместо win_chocolatey, так как win_hotfix избегает использованияwusa.exe, который нельзя запустить безbecome.
См. также
См. также
- win_chocolatey_config – Управление настройками Chocolatey
- Официальная документация по модулю win_chocolatey_config.
- win_chocolatey_facts – Создание коллекции фактов для Chocolatey
- Официальная документация по модулю win_chocolatey_facts.
- win_chocolatey_feature – Управление функциями Chocolatey
- Официальная документация по модулю win_chocolatey_feature.
- win_chocolatey_source – Управление источниками Chocolatey
- Официальная документация по модулю win_chocolatey_source.
- win_feature – Установка и удаление функций Windows на Windows Server
- Официальная документация по модулю win_feature.
- win_hotfix – Установка и удаление исправлений Windows
- Используется, когда
becomeнедоступен, чтобы избежать использованияwusa.exe. - win_package – Установка/удаление устанавливаемого пакета
- Официальная документация по модулю win_package.
- win_updates – Загрузка и установка обновлений Windows
- Официальная документация по модулю win_updates.
- Веб-сайт Chocolatey
- Дополнительная информация о инструменте Chocolatey.
- Пакеты Chocolatey
- Обзор доступных пакетов Chocolatey.
- Become и Windows
- Для установки некоторых пакетов, таких как исправления или обновления, требуется интерактивный вход пользователя. Для этого можно использовать
become.
Примеры
- name: Install git
win_chocolatey:
name: git
state: present
- name: Upgrade installed packages
win_chocolatey:
name: all
state: latest
- name: Install notepadplusplus version 6.6
win_chocolatey:
name: notepadplusplus
version: '6.6'
- name: Install notepadplusplus 32 bit version
win_chocolatey:
name: notepadplusplus
architecture: x86
- name: Install git from specified repository
win_chocolatey:
name: git
source: https://someserver/api/v2/
- name: Install git from a pre configured source (win_chocolatey_source)
win_chocolatey:
name: git
source: internal_repo
- name: Ensure Chocolatey itself is installed and use internal repo as source
win_chocolatey:
name: chocolatey
source: http://someserver/chocolatey
- name: Uninstall git
win_chocolatey:
name: git
state: absent
- name: Install multiple packages
win_chocolatey:
name:
- procexp
- putty
- windirstat
state: present
- name: Install multiple packages sequentially
win_chocolatey:
name: '{{ item }}'
state: present
loop:
- procexp
- putty
- windirstat
- name: Uninstall multiple packages
win_chocolatey:
name:
- procexp
- putty
- windirstat
state: absent
- name: Install curl using proxy
win_chocolatey:
name: curl
proxy_url: http://proxy-server:8080/
proxy_username: joe
proxy_password: p@ssw0rd
- name: Install a package that requires 'become'
win_chocolatey:
name: officepro2013
become: yes
become_user: Administrator
become_method: runas
- name: install and pin Notepad++ at 7.6.3
win_chocolatey:
name: notepadplusplus
version: 7.6.3
pinned: yes
state: present
- name: remove all pins for Notepad++ on all versions
win_chocolatey:
name: notepadplusplus
pinned: no
state: present
Значения возврата
Общие значения возврата описаны здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| command строка | изменён | Полная команда, используемая в задаче chocolatey. Пример: choco.exe install -r --no-progress -y sysinternals --timeout 2700 --failonunfound |
| rc целое число | всегда | Код возврата задачи chocolatey. |
| stdout строка | изменён | Вывод stdout задачи chocolatey. Уровень подробности сообщений зависит от настроек уровня подробности Ansible, см. примечания для получения более подробной информации. Пример: Chocolatey upgraded 1/1 packages. |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Trond Hindenes (@trondhindenes)
- Peter Mounce (@petemounce)
- Pepe Barbe (@elventear)
- Adam Keech (@smadam813)
- Pierre Templier (@ptemplier)
- Jordan Borean (@jborean93)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/win_chocolatey_module.html