Spec-Zone.ru › Ansible 2.11

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/ru-ru/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/ru-ru/dotnet/api/system.management.automation.moduletype

Пример:
Script
name
строка
успех
Имя модуля.

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

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

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

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

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

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

Пример:
5.1
prefix
строка
success
Предпочтительный префикс, применяемый к командам Verb-Noun, экспортированным из модуля, что приводит к именам Verb-PrefixNoun.

private_data
словарь
success
Произвольные данные, используемые модулем. Обычно они определяются в манифесте модуля.
Этот модуль ограничивает глубину возвращаемых данных для типов модулей, отличных от Script и Manifest.
Данные PSData обычно предоставляются и содержат метаданные для PowerShellGet, но эти поля также отображаются в свойствах верхнего уровня.

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

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

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

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

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

Пример:
PSGallery
repository_source_location
строка
success
Расположение источника хранилища, откуда был установлен модуль.

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

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

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

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

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

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

Пример:
1.2.3


Авторы

  • Brian Scholer (@briantist)

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

Spec-Zone.ru

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