ns2.col.foo module – Do some foo bar

Note

This module is part of the ns2.col collection (version 2.1.0).

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 ns2.col. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: ns2.col.foo.

New in ns2.col 2.0.0

Synopsis

Aliases: foo_1_redirect, foo_2_redirect, foo_redirect

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

bar

aliases: baz

list / elements=integer

A bar.

Independent from foo.

Do not confuse with bar.

foo

string / required

The foo source.

manager

list / elements=string

The package manager(s) used by the system so we can query the package information. This is a list and can support multiple package managers per system, since version 2.8.

The ‘portage’ and ‘pkg’ options were added in version 2.8.

The ‘apk’ option was added in version 2.11.

The ‘pkg_info’ option was added in version 2.13.

Aliases were added in 2.18, to support using auto={{ansible_facts['pkg_mgr']}}

Choices:

  • "apk": Alpine Linux package manager

  • "apt": For DEB based distros, python-apt package must be installed on targeted hosts

  • "auto" (default): Depending on strategy, will match the first or all package managers provided, in order

  • "dnf": Alias to rpm

  • "dnf5": Alias to rpm

  • "openbsd_pkg": Alias to pkg_info

  • "pacman": Archlinux package manager/builder

  • "pkg": libpkg front end (FreeBSD)

  • "pkg5": Alias to pkg

  • "pkg_info": OpenBSD package manager

  • "pkgng": Alias to pkg

  • "portage": Handles ebuild packages, it requires the qlist utility, which is part of ‘app-portage/portage-utils’

  • "rpm": For RPM based distros, requires RPM Python bindings, not installed by default on Suse (python3-rpm)

  • "yum": Alias to rpm

  • "zypper": Alias to rpm

Default: ["auto"]

subfoo

dictionary

added in ns2.col 2.0.0

Some recursive foo.

foo

string / required

A sub foo.

Whatever.

Also required when subfoo is specified when foo=bar or baz.

Attributes

Attribute

Support

Description

action_group

Action group: ns2.col.foo_group

Use group/ns2.col.foo_group in module_defaults to set defaults for this module.

check_mode

Support: full

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

diff_mode

Support: full

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

platform

Platform: posix

Target OS/families that can be operated against

See Also

See also

ns2.col.foo2

Another foo.

ns2.col.foo lookup plugin

Look up some foo bar.

ansible.builtin.service

The service module.

ansible.builtin.ssh connection plugin

The ssh connection plugin.

Examples

- name: Do some foo
  ns2.col.foo:
    foo: '{{ foo }}'
    bar:
      - 1
      - 2
      - 3
    subfoo:
      foo: hoo!

Return Values

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

Key

Description

bar

string

Some bar.

Referencing myself as bar.

Do not confuse with bar.

Returned: success

Sample: "baz"

Authors

  • Ansible Core Team

  • Someone else (@ansible)