ansible.builtin.pkgng (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Manage binary packages for FreeBSD using 'pkgng' which is available in versions after 9.0.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Install package foo
  pkgng:
    name: foo
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Annotate package foo and bar
  pkgng:
    name: foo,bar
    annotation: '+test1=baz,-test2,:test3=foobar'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove packages foo and bar
  pkgng:
    name: foo,bar
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# "latest" support added in 2.7
- name: Upgrade package baz
  pkgng:
    name: baz
    state: latest

Inputs

    
jail:
    description:
    - Pkg will execute in the given jail name or id.
    - Can not be used together with I(chroot) or I(rootdir) options.
    version_added: '2.4'
    version_added_collection: ansible.builtin

name:
    description:
    - Name or list of names of packages to install/remove.
    required: true

state:
    choices:
    - present
    - latest
    - absent
    default: present
    description:
    - State of the package.
    - 'Note: "latest" added in 2.7'
    required: false

cached:
    default: false
    description:
    - Use local package base instead of fetching an updated one.
    required: false
    type: bool

chroot:
    description:
    - Pkg will chroot in the specified environment.
    - Can not be used together with I(rootdir) or I(jail) options.
    required: false
    version_added: '2.1'
    version_added_collection: ansible.builtin

pkgsite:
    description:
    - For pkgng versions before 1.1.4, specify packagesite to use for downloading packages.
      If not specified, use settings from C(/usr/local/etc/pkg.conf).
    - For newer pkgng versions, specify a the name of a repository configured in C(/usr/local/etc/pkg/repos).
    required: false

rootdir:
    description:
    - For pkgng versions 1.5 and later, pkg will install all packages within the specified
      root directory.
    - Can not be used together with I(chroot) or I(jail) options.
    required: false

annotation:
    description:
    - A comma-separated list of keyvalue-pairs of the form C(<+/-/:><key>[=<value>]).
      A C(+) denotes adding an annotation, a C(-) denotes removing an annotation, and
      C(:) denotes modifying an annotation. If setting or modifying annotations, a value
      must be provided.
    required: false
    version_added: '1.6'
    version_added_collection: ansible.builtin

autoremove:
    default: false
    description:
    - Remove automatically installed packages which are no longer needed.
    required: false
    type: bool
    version_added: '2.2'
    version_added_collection: ansible.builtin