win_psmodule – Adds or removes a Powershell Module

From Get docs
Ansible/docs/2.7/modules/win psmodule module


win_psmodule – Adds or removes a Powershell Module

New in version 2.4.


Synopsis

  • This module helps to install Powershell modules and register custom modules repository on Windows Server.

Parameters

Parameter Choices/Defaults Comments

allow_clobber

boolean

  • no

  • yes

If yes imports all commands, even if they have the same names as commands that already exists. Available only in Powershell 5.1 or higher.

name

- / required

Name of the powershell module that has to be installed.

repository

-

Name of the custom repository to register or use.

state

-

  • absent
  • present

If present a new module is installed.

If absent a module is removed.

url

-

URL of the custom repository to register.



Notes

Note

  • Powershell 5.0 or higher is needed.


Examples

---
- name: Add a powershell module
  win_psmodule:
    name: PowershellModule
    state: present

- name: Add a powershell module and register a repository
  win_psmodule:
    name: MyCustomModule
    repository: MyRepository
    url: https://myrepo.com
    state: present

- name: Add a powershell module from a specific repository
  win_psmodule:
    name: PowershellModule
    repository: MyRepository
    state: present

- name: Remove a powershell module
  win_psmodule:
    name: PowershellModule
    state: absent

- name: Remove a powershell module and a repository
  win_psmodule:
    name: MyCustomModule
    repository: MyRepository
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

nuget_changed

boolean

always

true when Nuget package provider is installed


Sample:

True

output

string

always

a message describing the task result.


Sample:

Module PowerShellCookbook installed

repository_changed

boolean

always

true when a custom repository is installed or removed


Sample:

True




Status

Authors

  • Daniele Lazzari

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/win_psmodule_module.html