Модуль community.windows.win_psmodule – Добавление или удаление модуля Windows PowerShell

Примечание

Этот модуль является частью коллекции community.windows (версия 2.3.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install community.windows.

Для использования в playbook, укажите: community.windows.win_psmodule.

Краткое описание
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

Этот модуль помогает устанавливать модули Windows PowerShell и регистрировать репозитории пользовательских модулей в системах на базе Windows.

Параметры

Параметр	Комментарии
accept_license boolean добавлено в community.windows 1.11.0	Принимает лицензию модуля. Требуется для модулей, требующих принятия лицензии, поскольку интерактивный ответ на запрос невозможен. Соответствует параметру `-AcceptLicense` параметра `Install-Module`. Установка модуля или зависимости, требующей принятия лицензии, не может быть обнаружена в режиме проверки, но вызовет ошибку во время выполнения, если accept_license=true не указано. Варианты: `false` ← (по умолчанию) `true`
allow_clobber boolean	Если `yes` разрешает установку модулей, содержащих команды с такими же именами, как и уже существующие команды. Варианты: `false` ← (по умолчанию) `true`
allow_prerelease boolean	Если `yes` устанавливает модули, помеченные как предварительные версии. Не работает с параметрами `minimum_version` и/или `maximum_version`. Не работает, если `state` установлено в absent. Варианты: `false` ← (по умолчанию) `true`
force boolean добавлено в community.windows 1.13.0	Переопределяет предупреждающие сообщения о конфликтах при установке модулей Если существует модуль с тем же именем и версией, force перезаписывает эту версию Соответствует параметру `-Force` параметра `Install-Module`. Если модуль является зависимостью, он также принудительно переустановит зависимость. Обновление до последней версии, если версия не указана в манифесте модуля. Варианты: `false` ← (по умолчанию) `true`
maximum_version string	Максимальная версия модуля PowerShell, которая должна быть установлена.
minimum_version string	Минимальная версия модуля PowerShell, которая должна быть установлена.
name string / required	Имя модуля Windows PowerShell, который должен быть установлен.
password string добавлено в community.windows 1.10.0	Пароль для аутентификации в частном репозитории.
repository string	Имя пользовательского репозитория для использования.
required_version string	Точная версия модуля PowerShell, которая должна быть установлена.
skip_publisher_check boolean	Если `yes`, позволяет установить другую версию модуля, который уже существует на вашем компьютере, в случае, когда другой модуль не подписан доверенным издателем, а самый новый существующий модуль подписан доверенным издателем. Варианты: `false` ← (по умолчанию) `true`
state string	Если `present` устанавливается новый модуль. Если `absent` модуль удаляется. Если `latest` модуль обновляется до последней версии. Варианты: `"absent"` `"latest"` `"present"` ← (по умолчанию)
username string добавлено в community.windows 1.10.0	Имя пользователя для аутентификации в частном репозитории.

Примечания

Примечание

Требуются модули PowerShell - PowerShellGet >= 1.6.0 - PackageManagement >= 1.1.7
Требуется поставщик пакетов PowerShell - NuGet >= 2.8.5.201
В PowerShell 5.x необходимые модули и поставщик пакетов будут обновлены при первом запуске модуля win_psmodule.
В PowerShell 3.x и 4.x вы должны установить их перед использованием win_psmodule.

См. также

community.windows.win_psrepository: Добавляет, удаляет или обновляет репозиторий Windows PowerShell.

Примеры

---
- name: Add a PowerShell module
  community.windows.win_psmodule:
    name: PowerShellModule
    state: present

- name: Add an exact version of PowerShell module
  community.windows.win_psmodule:
    name: PowerShellModule
    required_version: "4.0.2"
    state: present

- name: Install or update an existing PowerShell module to the newest version
  community.windows.win_psmodule:
    name: PowerShellModule
    state: latest

- name: Install newer version of built-in Windows module
  community.windows.win_psmodule:
    name: Pester
    skip_publisher_check: true
    state: present

- name: Add a PowerShell module and register a repository
  community.windows.win_psmodule:
    name: MyCustomModule
    repository: MyRepository
    state: present

- name: Add a PowerShell module from a specific repository
  community.windows.win_psmodule:
    name: PowerShellModule
    repository: MyRepository
    state: present

- name: Add a PowerShell module from a specific repository with credentials
  win_psmodule:
    name: PowerShellModule
    repository: MyRepository
    username: repo_username
    password: repo_password
    state: present

- name: Remove a PowerShell module
  community.windows.win_psmodule:
    name: PowerShellModule
    state: absent

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
nuget_changed boolean	Истина, когда поставщик пакетов Nuget установлен. Возвращается: всегда Пример: `true`
output string	Сообщение, описывающее результат задачи. Возвращается: всегда Пример: `"Module PowerShellCookbook installed"`
repository_changed boolean	Истина, когда пользовательский репозиторий установлен или удален. Возвращается: всегда Пример: `true`

Авторы

Wojciech Sciesinski (@it-praktyk)
Daniele Lazzari (@dlazz)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/windows/win_psmodule_module.html