Spec-Zone.ru › Ansible 2.10

community.windows.win_psmodule_info – Сбор информации о модулях PowerShell

Примечание

Этот плагин входит в коллекцию community.windows (версия 1.2.0).

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

Чтобы использовать его в книге задач, укажите: community.windows.win_psmodule_info.

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

Описание

  • Сбор информации о модулях PowerShell, включая данные из PowerShellGet.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

  • PowerShellGet модуль

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
name
строка
Значение по умолчанию:
"*"
Имя модуля для получения.
Поддерживает любые шаблоны подстановок, поддерживаемые Get-Module.
Если опущено, будут возвращены все модули.
repository
строка
Имя хранилища PSRepository, из которого были установлены модули.
Это используется как фильтр для модулей, которые будут возвращены на основе параметра name.
Модули, которые не были установлены из хранилища, не будут возвращены, если этот параметр задан.
Будут возвращены только модули, установленные из зарегистрированного хранилища.
Если хранилище было перерегистрировано после установки модуля с новым SourceLocation, это не будет соответствовать.

См. также

См. также

community.windows.win_psrepository_info

Официальная документация модуля community.windows.win_psrepository_info.

community.windows.win_psscript_info

Официальная документация модуля community.windows.win_psscript_info.

Примеры

- name: Get info about all modules on the system
  community.windows.win_psmodule_info:

- name: Get info about the ScheduledTasks module
  community.windows.win_psmodule_info:
    name: ScheduledTasks

- name: Get info about networking modules
  community.windows.win_psmodule_info:
    name: Net*

- name: Get info about all modules installed from the PSGallery repository
  community.windows.win_psmodule_info:
    repository: PSGallery
  register: gallery_modules

- name: Update all modules retrieved from above example
  community.windows.win_psmodule:
    name: "{{ item }}"
    state: latest
  loop: "{{ gallery_modules.modules | map(attribute=name) }}"

- name: Get info about all modules on the system
  community.windows.win_psmodule_info:
  register: all_modules

- name: Find modules installed from a repository that isn't registered now
  set_fact:
    missing_repository_modules: "{{
      all_modules
      | json_query('modules[?repository!=null && repository==repository_source_location].{name: name, version: version, repository: repository}')
      | list
    }}"

- debug:
    var: missing_repository_modules

Возвращаемые значения

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

Ключ Возвращаемое значение Описание
modules
список / элементы=словарь
всегда
Список модулей (или пустой список, если модулей нет).
access_mode
строка
успех
Режим доступа к модулю. См. https://docs.microsoft.com/en-us/dotnet/api/system.management.automation.moduleaccessmode

Пример:
ReadWrite
author
строка
успех
Автор модуля.

Пример:
Warren Frame
clr_version
строка
успех
Версия CLR модуля.

Пример:
4.0
company_name
строка
успех
Название компании-разработчика модуля.

Пример:
Microsoft Corporation
compatible_ps_editions
список / элементы=строка
успех
Поддерживаемые редакции PowerShell.

Пример:
['Desktop']
copyright
строка
успех
Авторские права на модуль.

Пример:
(c) 2016 Warren F. Все права защищены.
dependencies
список / элементы=строка
успех
Модули, необходимые для работы этого модуля.
description
строка
успех
Описание модуля.

Пример:
Предоставляет командлеты для работы с локальными пользователями и группами.
dot_net_framework_version
строка
успех
Версия .NET Framework модуля.

Пример:
4.6.1
exported_aliases
список / элементы=строка
успех
Псевдонимы, экспортируемые из модуля.

Пример:
['glu', 'slu']
exported_cmdlets
список / элементы=строка
успех
Командлеты, экспортируемые из модуля.

Пример:
['Get-Certificate', 'Get-PfxData']
exported_commands
список / элементы=строка
успех
Все командлеты, функции и псевдонимы, экспортируемые из модуля.

Пример:
['glu', 'Get-LocalUser']
exported_dsc_resources
список / элементы=строка
успех
DSC-ресурсы, экспортируемые из модуля.

Пример:
['xWebAppPool', 'xWebSite']
exported_format_files
список / элементы=путь
успех
Файлы форматирования, экспортируемые из модуля.

Пример:
['C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\DnsClient\\DnsCmdlets.Format.ps1xml', 'C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\DnsClient\\DnsConfig.Format.ps1xml', 'C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\DnsClient\\DnsClientPSProvider.Format.ps1xml']
exported_functions
список / элементы=строка
успех
Функции, экспортируемые из модуля.

Пример:
['New-VirtualDisk', 'New-Volume']
exported_type_files
список / элементы=путь
успех
Файлы типов, экспортируемые из модуля.

Пример:
['C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\DnsClient\\DnsCmdlets.Types.ps1xml', 'C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\DnsClient\\DnsConfig.Types.ps1xml', 'C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\DnsClient\\DnsClientPSProvider.Types.ps1xml']
exported_variables
список / элементы=строка
успех
Переменные, экспортируемые из модуля.

Пример:
['GitPromptScriptBlock']
exported_workflows
список / элементы=строка
успех
Рабочие процессы, экспортируемые из модуля.
file_list
список / элементы=путь
успех
Файлы, включенные в модуль.

Пример:
['C:\\Program Files\\WindowsPowerShell\\Modules\\PowerShellGet\\1.6.0\\PSModule.psm1', 'C:\\Program Files\\WindowsPowerShell\\Modules\\PowerShellGet\\1.6.0\\PSGet.Format.ps1xml', 'C:\\Program Files\\WindowsPowerShell\\Modules\\PowerShellGet\\1.6.0\\PSGet.Resource.psd1']
guid
строка
успех
GUID модуля.

Пример:
74c9fd30-734b-4c89-a8ae-7727ad21d1d5
help_info_uri
строка
успех
Ссылка на справку по модулю.

Пример:
https://go.microsoft.com/fwlink/?linkid=390823
icon_uri
строка
успех
Ссылка на иконку модуля.

Пример:
https://raw.githubusercontent.com/powershell/psscriptanalyzer/master/logo.png
installed_date
строка
успех
Дата установки модуля.

Пример:
2018-02-14T17:55:34.9620740-05:00
installed_location
строка
успех
Путь к установке модуля.
Должен совпадать со значением module_base, но присутствует только при установке модуля через PowerShellGet.

Пример:
C:\Program Files\WindowsPowerShell\Modules\posh-git\0.7.1
license_uri
строка
успех
Ссылка на лицензию модуля.

Пример:
https://github.com/PowerShell/xPendingReboot/blob/master/LICENSE
log_pipeline_execution_details
логический
успех
Определяет, должны ли события выполнения конвейера регистрироваться.
module_base
строка
успех
Путь, содержащий файлы модуля.

Пример:
C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules\PKI
module_list
список / элементы=словарь
успех
Список модулей, входящих в пакет.
Это значение возвращается не часто, и модули не обрабатываются автоматически.
guid
строка
успех
GUID модуля.

Пример:
82fdb72c-ecc5-4dfd-b9d5-83cf6eb9067f
maximum_version
строка
успех
Максимальная версия модуля.

Пример:
2.9
name
строка
успех
Название модуля.
Также может быть путём к файлу модуля.

Пример:
.\WindowsUpdateLog.psm1
required_version
строка
успех
Требуемая версия модуля.

Пример:
3.1.4
version
строка
успех
Минимальная версия модуля.

Пример:
2.0
module_type
строка
успех
Тип модуля. См. https://docs.microsoft.com/en-us/dotnet/api/system.management.automation.moduletype

Пример:
Сценарий
name
строка
успех
Название модуля.

Пример:
PSReadLine
вложенные_модули
список / элементы=словарь
success
Список вложенных модулей, загруженных в область видимости этого модуля.
Этот список содержит полные объекты модулей, поэтому каждый элемент может иметь все перечисленные здесь свойства, включая nested_modules.

поставщик_управления_пакетами
строка
success
Если модуль был установлен из PowerShellGet, это поставщик управления пакетами, который использовался.

Пример:
NuGet
путь
строка
success
Путь к модулю.

Пример:
C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules\PKI\PKI.psd1
имя_хоста_PowerShell
строка
success
Имя хоста PowerShell, который требуется для модуля.

Пример:
Хост Windows PowerShell ISE
версия_хоста_PowerShell
строка
success
Версия хоста PowerShell, которая требуется для модуля.

Пример:
1.1
версия_PowerShell
строка
success
Минимальная версия PowerShell, требуемая для модуля.

Пример:
5.1
префикс
строка
success
По умолчанию префикс, применяемый к командам, экспортированным из модуля, результатом чего являются имена Verb-PrefixNoun.
данные_с_приватным_доступом
словарь
success
Произвольные данные с приватным доступом, используемые модулем. Как правило, это определяется в манифесте модуля.
Этот модуль ограничивает глубину возвращаемых данных для типов модулей, отличных от Script и Manifest.
PSData обычно предоставляется и содержит метаданные для PowerShellGet, но эти поля также отображаются в свойствах верхнего уровня.

Пример:
{'PSData': {'LicenseUri': 'https://example.com/module/LICENSE', 'ProjectUri': 'https://example.com/module/', 'ReleaseNotes': 'v2 - Исправлены некоторые ошибки\nv1 - Первая версия\n', 'Tags': ['сетевое_оборудование', 'сериализация']}}
архитектура_процессора
строка
success
Архитектура процессора модуля. См. https://docs.microsoft.com/en-us/dotnet/api/system.reflection.processorarchitecture

Пример:
Amd64
адрес_проекта
строка
success
Адрес проекта модуля.

Пример:
https://github.com/psake/psake
дата_опубликования
строка
success
Дата публикации модуля.

Пример:
2017-03-15T04:18:09.0000000
примечания_к_релизу
строка
success
Примечания к выпуску модуля. Это поле свободной формы, и не следует предполагать какой-либо конкретный формат.

Пример:
## 1.4.6 - Обновление `HelpInfoUri` для указания последнего контента ## 1.4.5 - Исправление ошибки тупика при получении параметров в событии ## 1.4.4 - Исправление ошибки при установке модулей из частных источников
репозиторий
строка
success
PSRepository, откуда был установлен модуль.
Это значение не является историческим. Оно зависит от PSRepositories, которые зарегистрированы сейчас для текущего пользователя.
repository_source_location должен соответствовать текущему расположению источника зарегистрированного репозитория для получения имени репозитория.
Если соответствие отсутствует, это значение будет соответствовать repository_source_location.

Пример:
PSGallery
местоположение_источника_репозитория
строка
success
Местоположение источника репозитория, откуда был установлен модуль.

Пример:
https://www.powershellgallery.com/api/v2
требуемые_сборки
строка
success
Список сборок, необходимых модулю.
Значения могут быть простым именем или полным путем.

Пример:
['Microsoft.Management.Infrastructure.CimCmdlets.dll', 'Microsoft.Management.Infrastructure.Dll']
требуемые_модули
список / элементы=словарь
success
Список модулей, необходимых этому модулю.
Этот список содержит полные объекты модулей, поэтому каждый элемент может иметь все перечисленные здесь свойства, включая required_modules.
Эти объекты модулей, однако, могут не содержать полной информации, поэтому результаты могут отличаться от результатов прямой запроса модуля.
корневой_модуль
строка
success
Корневой модуль, как определено в манифесте.
Это может быть имя модуля, имя файла или полный путь.

Пример:
WindowsErrorReporting.psm1
скрипты
список / элементы=строка
success
Список скриптов (файлов .ps1), которые выполняются в состоянии сессии вызывающей стороны при импорте модуля.
Это значение берется из поля ScriptsToProcess в манифесте модуля.

Пример:
['PrepareEnvironment.ps1', 'InitializeData.ps1']
теги
список / элементы=строка
success
Определенные в метаданных модуля PSData теги.

Пример:
['сетевое_оборудование', 'сериализация', 'git', 'dsc']
дата_последнего_обновления
строка
success
Дата последнего обновления модуля.

Пример:
2019-12-31T09:20:02.0000000
версия
строка
success
Версия модуля.

Пример:
1.2.3


Авторы

  • Brian Scholer (@briantist)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API