community.general.cpanm module – Manages Perl library dependencies

Note

This module is part of the community.general collection (version 11.2.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.cpanm.

Synopsis

  • Manage Perl library dependencies using cpanminus.

Parameters

Parameter

Comments

executable

path

Override the path to the cpanm executable.

from_path

path

The local directory or tar.gz file to install from.

install_recommendations

boolean

added in community.general 10.3.0

If true, installs dependencies declared as recommends per META spec.

If false, it ensures the dependencies declared as recommends are not installed, overriding any decision made earlier in PERL_CPANM_OPT.

If parameter is not set, cpanm uses its existing defaults.

When these dependencies fail to install, cpanm continues the installation, since they are just recommendation.

Choices:

  • false

  • true

install_suggestions

boolean

added in community.general 10.3.0

If true, installs dependencies declared as suggests per META spec.

If false, it ensures the dependencies declared as suggests are not installed, overriding any decision made earlier in PERL_CPANM_OPT.

If parameter is not set, cpanm uses its existing defaults.

When these dependencies fail to install, cpanm continues the installation, since they are just suggestion.

Choices:

  • false

  • true

installdeps

boolean

Only install dependencies.

Choices:

  • false ← (default)

  • true

locallib

path

Specify the install base to install modules.

mirror

string

Specifies the base URL for the CPAN mirror to use.

mirror_only

boolean

Use the mirror’s index file instead of the CPAN Meta DB.

Choices:

  • false ← (default)

  • true

mode

string

added in community.general 3.0.0

Controls the module behavior. See notes below for more details.

The default changed from compatibility to new in community.general 9.0.0.

mode=new: The name parameter may refer to a module name, a distribution file, a HTTP URL or a git repository URL as described in cpanminus documentation. cpanm version specifiers are recognized. This is the default mode from community.general 9.0.0 onwards.

mode=compatibility: This was the default mode before community.general 9.0.0. name must be either a module name or a distribution file. If the perl module given by name is installed (at the exact version when specified), then nothing happens. Otherwise, it is installed using the cpanm executable. name cannot be an URL, or a git URL. cpanm version specifiers do not work in this mode.

ATTENTION: compatibility mode is deprecated and will be removed in community.general 13.0.0.

Choices:

  • "compatibility"

  • "new" ← (default)

name

aliases: pkg

string

The Perl library to install. Valid values change according to the mode, see notes for more details.

Note that for installing from a local path the parameter from_path should be used.

name_check

string

added in community.general 3.0.0

When mode=new, this parameter can be used to check if there is a module name installed (at version, when specified).

notest

boolean

Do not run unit tests.

Choices:

  • false ← (default)

  • true

version

string

Version specification for the perl module. When mode is new, cpanm version operators are accepted.

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Returns details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

See Also

See also

C(cpanm) command manual page

Manual page for the command.

Examples

- name: Install Dancer perl package
  community.general.cpanm:
    name: Dancer

- name: Install version 0.99_05 of the Plack perl package
  community.general.cpanm:
    name: MIYAGAWA/Plack-0.99_05.tar.gz

- name: Install Dancer into the specified locallib
  community.general.cpanm:
    name: Dancer
    locallib: /srv/webapps/my_app/extlib

- name: Install perl dependencies from local directory
  community.general.cpanm:
    from_path: /srv/webapps/my_app/src/

- name: Install Dancer perl package without running the unit tests in indicated locallib
  community.general.cpanm:
    name: Dancer
    notest: true
    locallib: /srv/webapps/my_app/extlib

- name: Install Dancer perl package from a specific mirror
  community.general.cpanm:
    name: Dancer
    mirror: 'http://cpan.cpantesters.org/'

- name: Install Dancer perl package into the system root path
  become: true
  community.general.cpanm:
    name: Dancer

- name: Install Dancer if it is not already installed OR the installed version is older than version 1.0
  community.general.cpanm:
    name: Dancer
    version: '1.0'

Return Values

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

Key

Description

cpanm_version

string

added in community.general 10.0.0

Version of CPANMinus.

Returned: always

Sample: "1.7047"

Authors

  • Franck Cuny (@fcuny)

  • Alexei Znamensky (@russoz)