Spec-Zone.ru › Ansible

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

Примечание

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

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

Для установки используйте: 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

Сбор информации о PSRepositories.

community.windows.win_psscript_info

Сбор информации об установленных скриптах PowerShell.

Примеры

- 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. All rights reserved."

dependencies

список / элементы=строка

Модули, необходимые для работы данного модуля.

Возвращается: успешно

description

строка

Описание модуля.

Возвращается: успешно

Пример: "Provides cmdlets to work with local users and local groups"

dot_net_framework_version

строка

Версия .Net Framework модуля.

Возвращается: успешно

Пример: "4.6.1"

exported_aliases

список / элементы=строка

Псевдонимы, экспортированные из модуля.

Возвращается: успешно

Пример: ["glu", "slu"]

exported_cmdlets

список / элементы=строка

Команды (cmdлеты), экспортированные из модуля.

Возвращается: успешно

Пример: ["Get-Certificate", "Get-PfxData"]

exported_commands

список / элементы=строка

Все команды, экспортированные из модуля. Включает функции, cmdлеты и псевдонимы.

Возвращается: успешно

Пример: ["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

list / elements=path

Файлы типов, экспортируемые из модуля.

Возвращается: success

Пример: ["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

list / elements=string

Переменные, экспортируемые из модуля.

Возвращается: success

Пример: ["GitPromptScriptBlock"]

exported_workflows

list / elements=string

Воркфлоу, экспортируемые из модуля.

Возвращается: success

file_list

list / elements=path

Файлы, включенные в модуль.

Возвращается: success

Пример: ["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

string

GUID модуля.

Возвращается: success

Пример: "74c9fd30-734b-4c89-a8ae-7727ad21d1d5"

help_info_uri

string

Адрес справки по модулю.

Возвращается: success

Пример: "https://go.microsoft.com/fwlink/?linkid=390823"

icon_uri

string

Адрес значка модуля.

Возвращается: success

Пример: "https://raw.githubusercontent.com/powershell/psscriptanalyzer/master/logo.png"

installed_date

string

Дата установки модуля.

Возвращается: success

Пример: "2018-02-14T17:55:34.9620740-05:00"

installed_location

string

Путь, куда установлен модуль.

Это значение должно совпадать с module_base но имеет значение только тогда, когда модуль был установлен через PowerShellGet.

Возвращается: success

Пример: "C:\\Program Files\\WindowsPowerShell\\Modules\\posh-git\\0.7.1"

license_uri

string

Адрес лицензии на модуль.

Возвращается: success

Пример: "https://github.com/PowerShell/xPendingReboot/blob/master/LICENSE"

log_pipeline_execution_details

boolean

Определяет, следует ли регистрировать события с подробными сведениями о выполнении конвейера.

Возвращается: success

module_base

string

Путь, содержащий файлы модуля.

Возвращается: success

Пример: "C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\PKI"

module_list

list / elements=dictionary

Список модулей, упакованных с этим модулем.

Это значение возвращается нечасто, и модули не обрабатываются автоматически.

Возвращается: success

guid

string

GUID модуля.

Возвращается: success

Пример: "82fdb72c-ecc5-4dfd-b9d5-83cf6eb9067f"

maximum_version

string

Максимальная версия модуля.

Возвращается: success

Пример: "2.9"

name

string

Имя модуля.

Это также может быть путь к файлу модуля.

Возвращается: success

Пример: ".\\WindowsUpdateLog.psm1"

required_version

string

Точная требуемая версия модуля.

Возвращается: success

Пример: "3.1.4"

version

string

Минимальная версия модуля.

Возвращено: success

Пример: "2.0"

module_type

string

Тип модуля. См. https://docs.microsoft.com/en-us/dotnet/api/system.management.automation.moduletype

Возвращено: success

Пример: "Script"

name

string

Название модуля.

Возвращено: success

Пример: "PSReadLine"

nested_modules

list / elements=dictionary

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

Этот список содержит полные объекты модулей, поэтому каждый элемент может иметь все перечисленные здесь свойства, включая nested_modules.

Возвращено: success

package_management_provider

string

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

Возвращено: success

Пример: "NuGet"

path

string

Путь к модулю.

Возвращено: success

Пример: "C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules\\PKI\\PKI.psd1"

power_shell_host_name

string

Название хоста PowerShell, который требуется модулю.

Возвращено: success

Пример: "Windows PowerShell ISE Host"

power_shell_host_version

string

Версия хоста PowerShell, которая требуется модулю.

Возвращено: success

Пример: "1.1"

power_shell_version

string

Минимальная версия PowerShell, которая требуется модулю.

Возвращено: success

Пример: "5.1"

prefix

string

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

Возвращено: success

private_data

dictionary

Произвольные личные данные, используемые модулем. Обычно это определяется в манифесте модуля.

Этот модуль ограничивает глубину возвращаемых данных для типов модулей, отличных от Script и Manifest.

PSData обычно предоставляется и предоставляет метаданные для PowerShellGet, но эти поля также отображаются в свойствах верхнего уровня.

Возвращено: success

Пример: {"PSData": {"LicenseUri": "https://example.com/module/LICENSE", "ProjectUri": "https://example.com/module/", "ReleaseNotes": "v2 - Fixed some bugs\nv1 - First release\n", "Tags": ["networking", "serialization"]}}

procoessor_architecture

string

Процессорная архитектура модуля. См. https://docs.microsoft.com/en-us/dotnet/api/system.reflection.processorarchitecture

Возвращено: success

Пример: "Amd64"

project_uri

string

Адрес проекта модуля.

Возвращено: success

Пример: "https://github.com/psake/psake"

published_date

string

Дата публикации модуля.

Возвращено: success

Пример: "2017-03-15T04:18:09.0000000"

release_notes

string

Заметки к выпуску модуля. Это поле свободного текста, и не следует предполагать какой-либо конкретный формат.

Возвращено: success

Пример: "## 1.4.6\n- Update `HelpInfoUri` to point to the latest content\n\n## 1.4.5\n- Bug fix for deadlock when getting parameters in an event\n\n## 1.4.4\n- Bug fix when installing modules from private feeds\n"

repository

string

Репозиторий PSRepository, из которого был установлен модуль.

Это значение не является историческим. Оно зависит от PSRepositories, которые зарегистрированы сейчас для текущего пользователя.

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

Если совпадения нет, то это значение будет соответствовать repository_source_location.

Возвращаемое значение: успех

Пример: "PSGallery"

repository_source_location

string

Расположение источника репозитория, из которого был установлен модуль.

Возвращаемое значение: успех

Пример: "https://www.powershellgallery.com/api/v2"

required_assemblies

string

Список сборок, необходимых модулю.

Значения могут быть простым именем или полным путем.

Возвращаемое значение: успех

Пример: "['Microsoft.Management.Infrastructure.CimCmdlets.dll', 'Microsoft.Management.Infrastructure.Dll']"

required_modules

list / elements=dictionary

Список модулей, необходимых для данного модуля.

Этот список содержит полные объекты модулей, поэтому каждый элемент может иметь все перечисленные здесь свойства, включая required_modules.

Однако эти объекты модулей могут не содержать полной информации, поэтому вы можете увидеть результаты, отличающиеся от тех, что были бы получены при непосредственном запросе модуля.

Возвращаемое значение: успех

root_module

string

Основной модуль, как определено в манифесте.

Это может быть имя модуля, имя файла или полный путь.

Возвращаемое значение: успех

Пример: "WindowsErrorReporting.psm1"

scripts

list / elements=string

Список скриптов (файлов .ps1), которые выполняются в состоянии сеанса вызывающего приложения при импорте модуля.

Это значение получено из поля ScriptsToProcess в манифесте модуля.

Возвращаемое значение: успех

Пример: ["PrepareEnvironment.ps1", "InitializeData.ps1"]

tags

list / elements=string

Теги, определенные в метаданных модуля PSData.

Возвращаемое значение: успех

Пример: ["networking", "serialization", "git", "dsc"]

updated_date

string

Дата последнего обновления модуля.

Возвращаемое значение: успех

Пример: "2019-12-31T09:20:02.0000000"

version

string

Версия модуля.

Возвращаемое значение: успех

Пример: "1.2.3"

Авторы

  • Brian Scholer (@briantist)

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

  • Система отслеживания ошибок
  • Репозиторий (исходный код)
  • Общение

© 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_info_module.html

Spec-Zone.ru

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