Модуль community.windows.win_psmodule — добавляет или удаляет модуль Windows PowerShell

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.windows.

Чтобы использовать её в плейбуке, укажите: 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` команды `Install-Module`. Если модуль является зависимостью, будет также принудительно выполнена повторная установка зависимости. Если версия не указана в манифесте модуля, зависимость будет обновлена до последней версии. Варианты: `false` ← (по умолчанию) `true`
maximum_version string	Максимальная версия модуля PowerShell, которую необходимо установить.
minimum_version string	Минимальная версия модуля PowerShell, которую необходимо установить.
name string / обязательный	Имя модуля 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/windows/win_psmodule_module.html