Class: Ansible::Ruby::Modules::Pkgng

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/packaging/os/pkgng.rb

Overview

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

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#annotation ⇒ Array<String>, ...

Returns A comma-separated list of keyvalue-pairs of the form C(<+/-/:><key>). 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.

Returns:

  • (Array<String>, String, nil) —

    A comma-separated list of keyvalue-pairs of the form C(<+/-/:><key>). 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.



24
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/pkgng.rb', line 24

attribute :annotation

#autoremove ⇒ Symbol?

Returns Remove automatically installed packages which are no longer needed.

Returns:

  • (Symbol, nil) —

    Remove automatically installed packages which are no longer needed.



40
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/pkgng.rb', line 40

attribute :autoremove

#cached ⇒ Symbol?

Returns Use local package base instead of fetching an updated one.

Returns:

  • (Symbol, nil) —

    Use local package base instead of fetching an updated one.



20
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/pkgng.rb', line 20

attribute :cached

#chroot ⇒ Object?

Returns Pkg will chroot in the specified environment.,Can not be used together with I(rootdir) or I(jail) options.

Returns:

  • (Object, nil) —

    Pkg will chroot in the specified environment.,Can not be used together with I(rootdir) or I(jail) options.



34
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/pkgng.rb', line 34

attribute :chroot

#jail ⇒ Object?

Returns Pkg will execute in the given jail name or id.,Can not be used together with I(chroot) or I(rootdir) options.

Returns:

  • (Object, nil) —

    Pkg will execute in the given jail name or id.,Can not be used together with I(chroot) or I(rootdir) options.



37
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/pkgng.rb', line 37

attribute :jail

#name ⇒ Array<String>, String

Returns Name or list of names of packages to install/remove.

Returns:

  • (Array<String>, String) —

    Name or list of names of packages to install/remove.



12
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/pkgng.rb', line 12

attribute :name

#pkgsite ⇒ Object?

Returns 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).

Returns:

  • (Object, nil) —

    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).



28
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/pkgng.rb', line 28

attribute :pkgsite

#rootdir ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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.



31
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/pkgng.rb', line 31

attribute :rootdir

#state ⇒ :present, ...

Returns State of the package.,Note: “latest” added in 2.7.

Returns:

  • (:present, :latest, :absent, nil) —

    State of the package.,Note: “latest” added in 2.7



16
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/pkgng.rb', line 16

attribute :state