win_chocolatey – Управление пакетами с помощью Chocolatey
Описание
- Управление пакетами с помощью Chocolatey.
- Если Chocolatey отсутствует в системе, модуль его установит.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- chocolatey >= 0.10.5 (будет обновлён, если версия старая)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| allow_empty_checksums boolean |
| Разрешить использование пустых контрольных сумм для загруженных ресурсов из ненадежных источников. Используйте win_chocolatey_feature с именем allowEmptyChecksums для управления этим параметром глобально. |
| allow_multiple boolean добавлено в 2.8 |
| Разрешить установку нескольких пакетов, когда указана версия. Наличие нескольких пакетов с разными версиями может вызвать проблемы, если пакет не поддерживает это. Используйте на свой страх и риск. |
| allow_prerelease boolean добавлено в 2.6 |
| Разрешить установку предварительных версий пакетов. Если состояние равно latest, будет установлена последняя предварительная версия пакета. |
| architecture строка добавлено в 2.7 |
| Принудительно установить пакет определенной архитектуры. При установке x86, Chocolatey будет гарантированно устанавливать пакет x86, даже на 64-битной ОС. |
| force boolean |
| Принудительно устанавливает пакет, даже если он уже установлен. Использование force заставит Ansible всегда сообщать о внесении изменений. |
| ignore_checksums boolean |
| Игнорировать предоставленные контрольные суммы пакета. Используйте win_chocolatey_feature с именем checksumFiles для управления этим параметром глобально. |
| ignore_dependencies boolean |
| Игнорировать зависимости, установить/обновить только сам пакет. |
| install_args строка | Аргументы для передачи установочному скрипту. Это аргументы, передаваемые непосредственно установочному скрипту пакета Chocolatey. Обычно используется в продвинутых случаях. | |
| name список / обязательно | Имя устанавливаемого пакета(ов). Установите all, чтобы выполнить действие для всех установленных пакетов. | |
| package_params строка | Параметры для передачи пакету. Это параметры, специфичные для пакета 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 целое число | Значение по умолчанию: 2700 | Время ожидания завершения работы Chocolatey. алиасы: execution_timeout |
| validate_certs boolean добавлено в 2.7 |
| Используется при загрузке скрипта установки Chocolatey, если Chocolatey ещё не установлен, это не влияет на процесс установки пакета Chocolatey. Когда no, сертификаты SSL не будут проверяться.Это следует использовать только на контролируемых сайтах с самозаверенными сертификатами. |
| version string | Указывается конкретная версия пакета для установки. Когда 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 string | изменённое | Полная команда, используемая в задаче chocolatey. Пример: choco.exe install -r --no-progress -y sysinternals --timeout 2700 --failonunfound |
| rc целое число | всегда | Код возврата задачи chocolatey. |
| stdout строка | изменённое | Вывод stdout задачи chocolatey. Уровень подробности сообщений зависит от настроек подробности Ansible, см. примечания для получения дополнительных сведений. Пример: Chocolatey upgraded 1/1 packages. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/win_chocolatey_module.html