1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Adjust booleans in packaging modules. (#5154)

This commit is contained in:
Felix Fontein 2022-08-24 19:59:13 +02:00 committed by GitHub
parent be2de15c66
commit ddc989ec6d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
38 changed files with 242 additions and 228 deletions

View file

@ -25,12 +25,12 @@ options:
description: description:
- Install packages from local cache, if the packages were installed before - Install packages from local cache, if the packages were installed before
type: bool type: bool
default: 'no' default: false
production: production:
description: description:
- Install with --production flag - Install with --production flag
type: bool type: bool
default: 'no' default: false
path: path:
type: path type: path
description: description:
@ -80,7 +80,7 @@ EXAMPLES = '''
- npm: - npm:
path: /app/location path: /app/location
name: bower name: bower
global: no global: false
- community.general.bower: - community.general.bower:
path: /app/location path: /app/location
relative_execpath: node_modules/.bin relative_execpath: node_modules/.bin

View file

@ -45,7 +45,7 @@ options:
- Only applies if state is C(present). If set removes any gems on the - Only applies if state is C(present). If set removes any gems on the
target host that are not in the gemfile target host that are not in the gemfile
type: bool type: bool
default: 'no' default: false
gemfile: gemfile:
type: path type: path
description: description:
@ -55,19 +55,19 @@ options:
description: description:
- If set only installs gems from the cache on the target host - If set only installs gems from the cache on the target host
type: bool type: bool
default: 'no' default: false
deployment_mode: deployment_mode:
description: description:
- Only applies if state is C(present). If set it will install gems in - Only applies if state is C(present). If set it will install gems in
./vendor/bundle instead of the default location. Requires a Gemfile.lock ./vendor/bundle instead of the default location. Requires a Gemfile.lock
file to have been created prior file to have been created prior
type: bool type: bool
default: 'no' default: false
user_install: user_install:
description: description:
- Only applies if state is C(present). Installs gems in the local user's cache or for all users - Only applies if state is C(present). Installs gems in the local user's cache or for all users
type: bool type: bool
default: 'yes' default: true
gem_path: gem_path:
type: path type: path
description: description:
@ -106,7 +106,7 @@ EXAMPLES = '''
- name: Install gems into ./vendor/bundle - name: Install gems into ./vendor/bundle
community.general.bundler: community.general.bundler:
state: present state: present
deployment_mode: yes deployment_mode: true
- name: Install gems using a Gemfile in another directory - name: Install gems using a Gemfile in another directory
community.general.bundler: community.general.bundler:

View file

@ -126,12 +126,12 @@ EXAMPLES = '''
command: create-project command: create-project
arguments: package/package /path/to/project ~1.0 arguments: package/package /path/to/project ~1.0
working_dir: /path/to/project working_dir: /path/to/project
prefer_dist: yes prefer_dist: true
- name: Install a package globally - name: Install a package globally
community.general.composer: community.general.composer:
command: require command: require
global_command: yes global_command: true
arguments: my/package arguments: my/package
''' '''

View file

@ -31,7 +31,7 @@ options:
description: description:
- Do not run unit tests. - Do not run unit tests.
type: bool type: bool
default: no default: false
locallib: locallib:
description: description:
- Specify the install base to install modules. - Specify the install base to install modules.
@ -44,12 +44,12 @@ options:
description: description:
- Use the mirror's index file instead of the CPAN Meta DB. - Use the mirror's index file instead of the CPAN Meta DB.
type: bool type: bool
default: no default: false
installdeps: installdeps:
description: description:
- Only install dependencies. - Only install dependencies.
type: bool type: bool
default: no default: false
version: version:
description: description:
- Version specification for the perl module. When I(mode) is C(new), C(cpanm) version operators are accepted. - Version specification for the perl module. When I(mode) is C(new), C(cpanm) version operators are accepted.
@ -122,7 +122,7 @@ EXAMPLES = '''
mirror: 'http://cpan.cpantesters.org/' mirror: 'http://cpan.cpantesters.org/'
- name: Install Dancer perl package into the system root path - name: Install Dancer perl package into the system root path
become: yes become: true
community.general.cpanm: community.general.cpanm:
name: Dancer name: Dancer

View file

@ -34,7 +34,7 @@ options:
have any effect, the environment must be deleted and newly have any effect, the environment must be deleted and newly
created. created.
type: bool type: bool
default: 'no' default: false
virtualenv_command: virtualenv_command:
type: str type: str
description: description:

View file

@ -38,7 +38,7 @@ options:
- Whether to include dependencies or not. - Whether to include dependencies or not.
required: false required: false
type: bool type: bool
default: "yes" default: true
repository: repository:
type: str type: str
description: description:
@ -50,7 +50,7 @@ options:
- Install gem in user's local gems cache or for all users - Install gem in user's local gems cache or for all users
required: false required: false
type: bool type: bool
default: "yes" default: true
executable: executable:
type: path type: path
description: description:
@ -80,7 +80,7 @@ options:
description: description:
- Rewrite the shebang line on installed scripts to use /usr/bin/env. - Rewrite the shebang line on installed scripts to use /usr/bin/env.
required: false required: false
default: "no" default: false
type: bool type: bool
version: version:
type: str type: str
@ -91,13 +91,13 @@ options:
description: description:
- Allow installation of pre-release versions of the gem. - Allow installation of pre-release versions of the gem.
required: false required: false
default: "no" default: false
type: bool type: bool
include_doc: include_doc:
description: description:
- Install with or without docs. - Install with or without docs.
required: false required: false
default: "no" default: false
type: bool type: bool
build_flags: build_flags:
type: str type: str
@ -108,7 +108,7 @@ options:
description: description:
- Force gem to install, bypassing dependency checks. - Force gem to install, bypassing dependency checks.
required: false required: false
default: "no" default: false
type: bool type: bool
author: author:
- "Ansible Core Team" - "Ansible Core Team"

View file

@ -83,7 +83,7 @@ options:
responds to an initial request with a 401 status. Since some basic auth services do not properly responds to an initial request with a 401 status. Since some basic auth services do not properly
send a 401, logins will fail. This option forces the sending of the Basic authentication header send a 401, logins will fail. This option forces the sending of the Basic authentication header
upon initial request. upon initial request.
default: 'no' default: false
type: bool type: bool
version_added: '0.2.0' version_added: '0.2.0'
dest: dest:
@ -105,9 +105,9 @@ options:
default: 10 default: 10
validate_certs: validate_certs:
description: description:
- If C(no), SSL certificates will not be validated. This should only be set to C(no) when no other option exists. - If C(false), SSL certificates will not be validated. This should only be set to C(false) when no other option exists.
type: bool type: bool
default: 'yes' default: true
client_cert: client_cert:
description: description:
- PEM formatted certificate chain file to be used for SSL client authentication. - PEM formatted certificate chain file to be used for SSL client authentication.
@ -122,11 +122,11 @@ options:
version_added: '1.3.0' version_added: '1.3.0'
keep_name: keep_name:
description: description:
- If C(yes), the downloaded artifact's name is preserved, i.e the version number remains part of it. - If C(true), the downloaded artifact's name is preserved, i.e the version number remains part of it.
- This option only has effect when C(dest) is a directory and C(version) is set to C(latest) or C(version_by_spec) - This option only has effect when C(dest) is a directory and C(version) is set to C(latest) or C(version_by_spec)
is defined. is defined.
type: bool type: bool
default: 'no' default: false
verify_checksum: verify_checksum:
type: str type: str
description: description:
@ -214,7 +214,7 @@ EXAMPLES = '''
artifact_id: spring-core artifact_id: spring-core
group_id: org.springframework group_id: org.springframework
dest: /tmp/ dest: /tmp/
keep_name: yes keep_name: true
- name: Download the latest version of the JUnit framework artifact from Maven local - name: Download the latest version of the JUnit framework artifact from Maven local
community.general.maven_artifact: community.general.maven_artifact:

View file

@ -35,7 +35,7 @@ options:
description: description:
- Install the node.js library globally. - Install the node.js library globally.
required: false required: false
default: no default: false
type: bool type: bool
executable: executable:
description: description:
@ -48,23 +48,23 @@ options:
- Use the C(--ignore-scripts) flag when installing. - Use the C(--ignore-scripts) flag when installing.
required: false required: false
type: bool type: bool
default: no default: false
unsafe_perm: unsafe_perm:
description: description:
- Use the C(--unsafe-perm) flag when installing. - Use the C(--unsafe-perm) flag when installing.
type: bool type: bool
default: no default: false
ci: ci:
description: description:
- Install packages based on package-lock file, same as running C(npm ci). - Install packages based on package-lock file, same as running C(npm ci).
type: bool type: bool
default: no default: false
production: production:
description: description:
- Install dependencies in production mode, excluding devDependencies. - Install dependencies in production mode, excluding devDependencies.
required: false required: false
type: bool type: bool
default: no default: false
registry: registry:
description: description:
- The registry to install modules from. - The registry to install modules from.
@ -81,13 +81,13 @@ options:
description: description:
- Use the C(--no-optional) flag when installing. - Use the C(--no-optional) flag when installing.
type: bool type: bool
default: no default: false
version_added: 2.0.0 version_added: 2.0.0
no_bin_links: no_bin_links:
description: description:
- Use the C(--no-bin-links) flag when installing. - Use the C(--no-bin-links) flag when installing.
type: bool type: bool
default: no default: false
version_added: 2.5.0 version_added: 2.5.0
requirements: requirements:
- npm installed in bin path (recommended /usr/local/bin) - npm installed in bin path (recommended /usr/local/bin)
@ -108,12 +108,12 @@ EXAMPLES = r'''
- name: Install "coffee-script" node.js package globally. - name: Install "coffee-script" node.js package globally.
community.general.npm: community.general.npm:
name: coffee-script name: coffee-script
global: yes global: true
- name: Remove the globally package "coffee-script". - name: Remove the globally package "coffee-script".
community.general.npm: community.general.npm:
name: coffee-script name: coffee-script
global: yes global: true
state: absent state: absent
- name: Install "coffee-script" node.js package from custom registry. - name: Install "coffee-script" node.js package from custom registry.

View file

@ -44,7 +44,7 @@ options:
description: description:
- Install the node.js library globally - Install the node.js library globally
required: false required: false
default: no default: false
type: bool type: bool
executable: executable:
type: path type: path
@ -56,14 +56,14 @@ options:
- Use the --ignore-scripts flag when installing. - Use the --ignore-scripts flag when installing.
required: false required: false
type: bool type: bool
default: no default: false
production: production:
description: description:
- Install dependencies in production mode. - Install dependencies in production mode.
- Yarn will ignore any dependencies under devDependencies in package.json - Yarn will ignore any dependencies under devDependencies in package.json
required: false required: false
type: bool type: bool
default: no default: false
registry: registry:
type: str type: str
description: description:
@ -96,12 +96,12 @@ EXAMPLES = '''
- name: Install "imagemin" node.js package globally. - name: Install "imagemin" node.js package globally.
community.general.yarn: community.general.yarn:
name: imagemin name: imagemin
global: yes global: true
- name: Remove the globally-installed package "imagemin". - name: Remove the globally-installed package "imagemin".
community.general.yarn: community.general.yarn:
name: imagemin name: imagemin
global: yes global: true
state: absent state: absent
- name: Install "imagemin" node.js package from custom registry. - name: Install "imagemin" node.js package from custom registry.

View file

@ -25,7 +25,7 @@ options:
- During upgrade, reset versioned world dependencies and change logic to prefer replacing or downgrading packages (instead of holding them) - During upgrade, reset versioned world dependencies and change logic to prefer replacing or downgrading packages (instead of holding them)
if the currently installed package is no longer available from any repository. if the currently installed package is no longer available from any repository.
type: bool type: bool
default: no default: false
name: name:
description: description:
- A package name, like C(foo), or multiple packages, like C(foo, bar). - A package name, like C(foo), or multiple packages, like C(foo, bar).
@ -35,7 +35,7 @@ options:
description: description:
- Do not use any local cache path. - Do not use any local cache path.
type: bool type: bool
default: no default: false
version_added: 1.0.0 version_added: 1.0.0
repository: repository:
description: description:
@ -56,12 +56,12 @@ options:
description: description:
- Update repository indexes. Can be run with other steps or on it's own. - Update repository indexes. Can be run with other steps or on it's own.
type: bool type: bool
default: no default: false
upgrade: upgrade:
description: description:
- Upgrade all installed packages to their latest version. - Upgrade all installed packages to their latest version.
type: bool type: bool
default: no default: false
world: world:
description: description:
- Use a custom world file when checking for explicitly installed packages. - Use a custom world file when checking for explicitly installed packages.
@ -77,12 +77,12 @@ EXAMPLES = '''
- name: Update repositories and install foo package - name: Update repositories and install foo package
community.general.apk: community.general.apk:
name: foo name: foo
update_cache: yes update_cache: true
- name: Update repositories and install foo and bar packages - name: Update repositories and install foo and bar packages
community.general.apk: community.general.apk:
name: foo,bar name: foo,bar
update_cache: yes update_cache: true
- name: Remove foo package - name: Remove foo package
community.general.apk: community.general.apk:
@ -108,39 +108,39 @@ EXAMPLES = '''
community.general.apk: community.general.apk:
name: foo name: foo
state: latest state: latest
update_cache: yes update_cache: true
- name: Update repositories and update packages foo and bar to latest versions - name: Update repositories and update packages foo and bar to latest versions
community.general.apk: community.general.apk:
name: foo,bar name: foo,bar
state: latest state: latest
update_cache: yes update_cache: true
- name: Update all installed packages to the latest versions - name: Update all installed packages to the latest versions
community.general.apk: community.general.apk:
upgrade: yes upgrade: true
- name: Upgrade / replace / downgrade / uninstall all installed packages to the latest versions available - name: Upgrade / replace / downgrade / uninstall all installed packages to the latest versions available
community.general.apk: community.general.apk:
available: yes available: true
upgrade: yes upgrade: true
- name: Update repositories as a separate step - name: Update repositories as a separate step
community.general.apk: community.general.apk:
update_cache: yes update_cache: true
- name: Install package from a specific repository - name: Install package from a specific repository
community.general.apk: community.general.apk:
name: foo name: foo
state: latest state: latest
update_cache: yes update_cache: true
repository: http://dl-3.alpinelinux.org/alpine/edge/main repository: http://dl-3.alpinelinux.org/alpine/edge/main
- name: Install package without using cache - name: Install package without using cache
community.general.apk: community.general.apk:
name: foo name: foo
state: latest state: latest
no_cache: yes no_cache: true
- name: Install package checking a custom world - name: Install package checking a custom world
community.general.apk: community.general.apk:

View file

@ -36,12 +36,12 @@ options:
- Remove other then added repositories - Remove other then added repositories
- Used if I(state=present) - Used if I(state=present)
type: bool type: bool
default: no default: false
update: update:
description: description:
- Update the package database after changing repositories. - Update the package database after changing repositories.
type: bool type: bool
default: no default: false
author: author:
- Mikhail Gordeev (@obirvalger) - Mikhail Gordeev (@obirvalger)
''' '''
@ -56,13 +56,13 @@ EXAMPLES = '''
community.general.apt_repo: community.general.apt_repo:
repo: Sisysphus repo: Sisysphus
state: present state: present
remove_others: yes remove_others: true
- name: Add local repository `/space/ALT/Sisyphus` and update package cache - name: Add local repository `/space/ALT/Sisyphus` and update package cache
community.general.apt_repo: community.general.apt_repo:
repo: copy:///space/ALT/Sisyphus repo: copy:///space/ALT/Sisyphus
state: present state: present
update: yes update: true
''' '''
RETURN = ''' # ''' RETURN = ''' # '''

View file

@ -35,7 +35,7 @@ options:
description: description:
- update the package database first C(apt-get update). - update the package database first C(apt-get update).
type: bool type: bool
default: no default: false
author: author:
- Evgenii Terechkov (@evgkrsk) - Evgenii Terechkov (@evgkrsk)
''' '''
@ -68,7 +68,7 @@ EXAMPLES = '''
community.general.apt_rpm: community.general.apt_rpm:
name: bar name: bar
state: present state: present
update_cache: yes update_cache: true
''' '''
import json import json

View file

@ -51,12 +51,12 @@ options:
description: description:
- update homebrew itself first. - update homebrew itself first.
type: bool type: bool
default: no default: false
upgrade_all: upgrade_all:
description: description:
- upgrade all homebrew packages. - upgrade all homebrew packages.
type: bool type: bool
default: no default: false
aliases: ['upgrade'] aliases: ['upgrade']
install_options: install_options:
description: description:
@ -91,18 +91,18 @@ EXAMPLES = '''
- community.general.homebrew: - community.general.homebrew:
name: foo name: foo
state: present state: present
update_homebrew: yes update_homebrew: true
# Update homebrew first and upgrade formula foo to latest available with 'brew' in default path # Update homebrew first and upgrade formula foo to latest available with 'brew' in default path
- community.general.homebrew: - community.general.homebrew:
name: foo name: foo
state: latest state: latest
update_homebrew: yes update_homebrew: true
# Update homebrew and upgrade all packages # Update homebrew and upgrade all packages
- community.general.homebrew: - community.general.homebrew:
update_homebrew: yes update_homebrew: true
upgrade_all: yes upgrade_all: true
# Miscellaneous other examples # Miscellaneous other examples
- community.general.homebrew: - community.general.homebrew:
@ -133,7 +133,7 @@ EXAMPLES = '''
- name: Use ignore-pinned option while upgrading all - name: Use ignore-pinned option while upgrading all
community.general.homebrew: community.general.homebrew:
upgrade_all: yes upgrade_all: true
upgrade_options: ignore-pinned upgrade_options: ignore-pinned
''' '''

View file

@ -51,7 +51,7 @@ options:
- Update homebrew itself first. - Update homebrew itself first.
- Note that C(brew cask update) is a synonym for C(brew update). - Note that C(brew cask update) is a synonym for C(brew update).
type: bool type: bool
default: no default: false
install_options: install_options:
description: description:
- Options flags to install a package. - Options flags to install a package.
@ -62,13 +62,13 @@ options:
description: description:
- Allow external apps. - Allow external apps.
type: bool type: bool
default: no default: false
upgrade_all: upgrade_all:
description: description:
- Upgrade all casks. - Upgrade all casks.
- Mutually exclusive with C(upgraded) state. - Mutually exclusive with C(upgraded) state.
type: bool type: bool
default: no default: false
aliases: [ 'upgrade' ] aliases: [ 'upgrade' ]
greedy: greedy:
description: description:
@ -76,7 +76,7 @@ options:
- Passes --greedy to brew cask outdated when checking - Passes --greedy to brew cask outdated when checking
if an installed cask has a newer version available. if an installed cask has a newer version available.
type: bool type: bool
default: no default: false
''' '''
EXAMPLES = ''' EXAMPLES = '''
- name: Install cask - name: Install cask

View file

@ -21,7 +21,7 @@ options:
description: description:
- Whether to accept the license for the package(s). - Whether to accept the license for the package(s).
type: bool type: bool
default: no default: false
name: name:
description: description:
- One or more packages to install or remove. - One or more packages to install or remove.
@ -49,28 +49,28 @@ EXAMPLES = r'''
community.general.installp: community.general.installp:
name: foo name: foo
repository_path: /repository/AIX71/installp/base repository_path: /repository/AIX71/installp/base
accept_license: yes accept_license: true
state: present state: present
- name: Install bos.sysmgt that includes bos.sysmgt.nim.master, bos.sysmgt.nim.spot - name: Install bos.sysmgt that includes bos.sysmgt.nim.master, bos.sysmgt.nim.spot
community.general.installp: community.general.installp:
name: bos.sysmgt name: bos.sysmgt
repository_path: /repository/AIX71/installp/base repository_path: /repository/AIX71/installp/base
accept_license: yes accept_license: true
state: present state: present
- name: Install bos.sysmgt.nim.master only - name: Install bos.sysmgt.nim.master only
community.general.installp: community.general.installp:
name: bos.sysmgt.nim.master name: bos.sysmgt.nim.master
repository_path: /repository/AIX71/installp/base repository_path: /repository/AIX71/installp/base
accept_license: yes accept_license: true
state: present state: present
- name: Install bos.sysmgt.nim.master and bos.sysmgt.nim.spot - name: Install bos.sysmgt.nim.master and bos.sysmgt.nim.spot
community.general.installp: community.general.installp:
name: bos.sysmgt.nim.master, bos.sysmgt.nim.spot name: bos.sysmgt.nim.master, bos.sysmgt.nim.spot
repository_path: /repository/AIX71/installp/base repository_path: /repository/AIX71/installp/base
accept_license: yes accept_license: true
state: present state: present
- name: Remove packages bos.sysmgt.nim.master - name: Remove packages bos.sysmgt.nim.master

View file

@ -43,11 +43,11 @@ options:
type: str type: str
validate_certs: validate_certs:
description: description:
- If C(no), SSL certificates will not be validated. This should only be - If C(false), SSL certificates will not be validated. This should only be
set to C(no) when no other option exists. Prior to 1.9.3 the code set to C(false) when no other option exists. Prior to 1.9.3 the code
defaulted to C(no). defaulted to C(false).
type: bool type: bool
default: yes default: true
''' '''
EXAMPLES = ''' EXAMPLES = '''

View file

@ -31,7 +31,7 @@ options:
- Update Macports and the ports tree, either prior to installing ports or as a separate step. - Update Macports and the ports tree, either prior to installing ports or as a separate step.
- Equivalent to running C(port selfupdate). - Equivalent to running C(port selfupdate).
aliases: ['update_cache', 'update_ports'] aliases: ['update_cache', 'update_ports']
default: "no" default: false
type: bool type: bool
state: state:
description: description:
@ -43,7 +43,7 @@ options:
description: description:
- Upgrade all outdated ports, either prior to installing ports or as a separate step. - Upgrade all outdated ports, either prior to installing ports or as a separate step.
- Equivalent to running C(port upgrade outdated). - Equivalent to running C(port upgrade outdated).
default: "no" default: false
type: bool type: bool
variant: variant:
description: description:
@ -72,13 +72,13 @@ EXAMPLES = '''
- name: Update Macports and the ports tree, then upgrade all outdated ports - name: Update Macports and the ports tree, then upgrade all outdated ports
community.general.macports: community.general.macports:
selfupdate: yes selfupdate: true
upgrade: yes upgrade: true
- name: Update Macports and the ports tree, then install the foo port - name: Update Macports and the ports tree, then install the foo port
community.general.macports: community.general.macports:
name: foo name: foo
selfupdate: yes selfupdate: true
- name: Remove the foo port - name: Remove the foo port
community.general.macports: community.general.macports:

View file

@ -40,7 +40,7 @@ options:
description: description:
- Upgrade all installed Mac App Store apps. - Upgrade all installed Mac App Store apps.
type: bool type: bool
default: "no" default: false
aliases: ["upgrade"] aliases: ["upgrade"]
requirements: requirements:
- macOS 10.11+ - macOS 10.11+
@ -77,7 +77,7 @@ EXAMPLES = '''
- name: Upgrade all installed Mac App Store apps - name: Upgrade all installed Mac App Store apps
community.general.mas: community.general.mas:
upgrade_all: yes upgrade_all: true
- name: Install specific apps and also upgrade all others - name: Install specific apps and also upgrade all others
community.general.mas: community.general.mas:
@ -85,13 +85,13 @@ EXAMPLES = '''
- 409183694 # Keynote - 409183694 # Keynote
- 413857545 # Divvy - 413857545 # Divvy
state: present state: present
upgrade_all: yes upgrade_all: true
- name: Uninstall Divvy - name: Uninstall Divvy
community.general.mas: community.general.mas:
id: 413857545 id: 413857545
state: absent state: absent
become: yes # Uninstallation requires root permissions become: true # Uninstallation requires root permissions
''' '''
RETURN = r''' # ''' RETURN = r''' # '''
@ -274,7 +274,7 @@ def main():
if mas.is_installed(app): if mas.is_installed(app):
# Ensure we are root # Ensure we are root
if os.getuid() != 0: if os.getuid() != 0:
module.fail_json(msg="Uninstalling apps requires root permissions ('become: yes')") module.fail_json(msg="Uninstalling apps requires root permissions ('become: true')")
mas.app_command('uninstall', app) mas.app_command('uninstall', app)

View file

@ -24,7 +24,7 @@ options:
name: name:
description: description:
- A name or a list of names of the packages. - A name or a list of names of the packages.
required: yes required: true
type: list type: list
elements: str elements: str
state: state:
@ -43,13 +43,13 @@ options:
not already installed. not already installed.
- Mutually exclusive with I(snapshot). - Mutually exclusive with I(snapshot).
type: bool type: bool
default: no default: false
snapshot: snapshot:
description: description:
- Force C(%c) and C(%m) to expand to C(snapshots), even on a release kernel. - Force C(%c) and C(%m) to expand to C(snapshots), even on a release kernel.
- Mutually exclusive with I(build). - Mutually exclusive with I(build).
type: bool type: bool
default: no default: false
version_added: 1.3.0 version_added: 1.3.0
ports_dir: ports_dir:
description: description:
@ -63,13 +63,13 @@ options:
file(s) in the old packages which are annotated with @extra in file(s) in the old packages which are annotated with @extra in
the packaging-list. the packaging-list.
type: bool type: bool
default: no default: false
quick: quick:
description: description:
- Replace or delete packages quickly; do not bother with checksums - Replace or delete packages quickly; do not bother with checksums
before removing normal files. before removing normal files.
type: bool type: bool
default: no default: false
notes: notes:
- When used with a C(loop:) each package will be processed individually, - When used with a C(loop:) each package will be processed individually,
it is much more efficient to pass the list directly to the I(name) option. it is much more efficient to pass the list directly to the I(name) option.
@ -95,7 +95,7 @@ EXAMPLES = '''
community.general.openbsd_pkg: community.general.openbsd_pkg:
name: nmap name: nmap
state: present state: present
build: yes build: true
- name: Specify a pkg flavour with '--' - name: Specify a pkg flavour with '--'
community.general.openbsd_pkg: community.general.openbsd_pkg:
@ -120,13 +120,13 @@ EXAMPLES = '''
- name: Purge a package and it's configuration files - name: Purge a package and it's configuration files
community.general.openbsd_pkg: community.general.openbsd_pkg:
name: mpd name: mpd
clean: yes clean: true
state: absent state: absent
- name: Quickly remove a package without checking checksums - name: Quickly remove a package without checking checksums
community.general.openbsd_pkg: community.general.openbsd_pkg:
name: qt5 name: qt5
quick: yes quick: true
state: absent state: absent
''' '''

View file

@ -67,7 +67,7 @@ EXAMPLES = '''
community.general.opkg: community.general.opkg:
name: foo name: foo
state: present state: present
update_cache: yes update_cache: true
- name: Remove foo - name: Remove foo
community.general.opkg: community.general.opkg:

View file

@ -48,7 +48,7 @@ options:
Same as C(extra_args="--nodeps --nodeps"). Same as C(extra_args="--nodeps --nodeps").
When combined with I(update_cache), force a refresh of all package databases. When combined with I(update_cache), force a refresh of all package databases.
Same as C(update_cache_extra_args="--refresh --refresh"). Same as C(update_cache_extra_args="--refresh --refresh").
default: no default: false
type: bool type: bool
remove_nosave: remove_nosave:
@ -56,7 +56,7 @@ options:
- When removing packages, do not save modified configuration files as C(.pacsave) files. - When removing packages, do not save modified configuration files as C(.pacsave) files.
(passes C(--nosave) to pacman) (passes C(--nosave) to pacman)
version_added: 4.6.0 version_added: 4.6.0
default: no default: false
type: bool type: bool
executable: executable:
@ -198,7 +198,7 @@ EXAMPLES = """
community.general.pacman: community.general.pacman:
name: foo name: foo
state: latest state: latest
update_cache: yes update_cache: true
- name: Remove packages foo and bar - name: Remove packages foo and bar
community.general.pacman: community.general.pacman:
@ -215,11 +215,11 @@ EXAMPLES = """
- name: Run the equivalent of "pacman -Sy" as a separate step - name: Run the equivalent of "pacman -Sy" as a separate step
community.general.pacman: community.general.pacman:
update_cache: yes update_cache: true
- name: Run the equivalent of "pacman -Su" as a separate step - name: Run the equivalent of "pacman -Su" as a separate step
community.general.pacman: community.general.pacman:
upgrade: yes upgrade: true
- name: Run the equivalent of "pacman -Syu" as a separate step - name: Run the equivalent of "pacman -Syu" as a separate step
# Since community.general 5.0.0 the 'changed' state of this call # Since community.general 5.0.0 the 'changed' state of this call
@ -232,14 +232,14 @@ EXAMPLES = """
# register: result # register: result
# changed_when: result.packages | length > 0 # changed_when: result.packages | length > 0
community.general.pacman: community.general.pacman:
update_cache: yes update_cache: true
upgrade: yes upgrade: true
- name: Run the equivalent of "pacman -Rdd", force remove package baz - name: Run the equivalent of "pacman -Rdd", force remove package baz
community.general.pacman: community.general.pacman:
name: baz name: baz
state: absent state: absent
force: yes force: true
- name: Install foo as dependency and leave reason untouched if already installed - name: Install foo as dependency and leave reason untouched if already installed
community.general.pacman: community.general.pacman:

View file

@ -36,7 +36,7 @@ options:
description: description:
- Accept any licences. - Accept any licences.
type: bool type: bool
default: no default: false
aliases: [ accept, accept_licences ] aliases: [ accept, accept_licences ]
be_name: be_name:
description: description:
@ -46,7 +46,7 @@ options:
description: description:
- Refresh publishers before execution. - Refresh publishers before execution.
type: bool type: bool
default: yes default: true
''' '''
EXAMPLES = ''' EXAMPLES = '''
- name: Install Vim - name: Install Vim
@ -56,7 +56,7 @@ EXAMPLES = '''
- name: Install Vim without refreshing publishers - name: Install Vim without refreshing publishers
community.general.pkg5: community.general.pkg5:
name: editor/vim name: editor/vim
refresh: no refresh: false
- name: Remove finger daemon - name: Remove finger daemon
community.general.pkg5: community.general.pkg5:

View file

@ -49,27 +49,27 @@ options:
description: description:
- Update repository database. Can be run with other steps or on it's own. - Update repository database. Can be run with other steps or on it's own.
type: bool type: bool
default: no default: false
upgrade: upgrade:
description: description:
- Upgrade main packages to their newer versions - Upgrade main packages to their newer versions
type: bool type: bool
default: no default: false
full_upgrade: full_upgrade:
description: description:
- Upgrade all packages to their newer versions - Upgrade all packages to their newer versions
type: bool type: bool
default: no default: false
clean: clean:
description: description:
- Clean packages cache - Clean packages cache
type: bool type: bool
default: no default: false
force: force:
description: description:
- Force package reinstall - Force package reinstall
type: bool type: bool
default: no default: false
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -86,7 +86,7 @@ EXAMPLES = '''
- name: Update cache and install foo package - name: Update cache and install foo package
community.general.pkgin: community.general.pkgin:
name: foo name: foo
update_cache: yes update_cache: true
- name: Remove package foo - name: Remove package foo
community.general.pkgin: community.general.pkgin:
@ -100,24 +100,24 @@ EXAMPLES = '''
- name: Update repositories as a separate step - name: Update repositories as a separate step
community.general.pkgin: community.general.pkgin:
update_cache: yes update_cache: true
- name: Upgrade main packages (equivalent to pkgin upgrade) - name: Upgrade main packages (equivalent to pkgin upgrade)
community.general.pkgin: community.general.pkgin:
upgrade: yes upgrade: true
- name: Upgrade all packages (equivalent to pkgin full-upgrade) - name: Upgrade all packages (equivalent to pkgin full-upgrade)
community.general.pkgin: community.general.pkgin:
full_upgrade: yes full_upgrade: true
- name: Force-upgrade all packages (equivalent to pkgin -F full-upgrade) - name: Force-upgrade all packages (equivalent to pkgin -F full-upgrade)
community.general.pkgin: community.general.pkgin:
full_upgrade: yes full_upgrade: true
force: yes force: true
- name: Clean packages cache (equivalent to pkgin clean) - name: Clean packages cache (equivalent to pkgin clean)
community.general.pkgin: community.general.pkgin:
clean: yes clean: true
''' '''

View file

@ -48,7 +48,7 @@ options:
- Use local package base instead of fetching an updated one. - Use local package base instead of fetching an updated one.
type: bool type: bool
required: false required: false
default: no default: false
annotation: annotation:
description: description:
- A list of keyvalue-pairs of the form - A list of keyvalue-pairs of the form
@ -91,14 +91,14 @@ options:
- Remove automatically installed packages which are no longer needed. - Remove automatically installed packages which are no longer needed.
required: false required: false
type: bool type: bool
default: no default: false
ignore_osver: ignore_osver:
description: description:
- Ignore FreeBSD OS version check, useful on -STABLE and -CURRENT branches. - Ignore FreeBSD OS version check, useful on -STABLE and -CURRENT branches.
- Defines the C(IGNORE_OSVERSION) environment variable. - Defines the C(IGNORE_OSVERSION) environment variable.
required: false required: false
type: bool type: bool
default: no default: false
version_added: 1.3.0 version_added: 1.3.0
author: "bleader (@bleader)" author: "bleader (@bleader)"
notes: notes:

View file

@ -47,12 +47,12 @@ options:
choices: [ absent, installed, latest, present, removed ] choices: [ absent, installed, latest, present, removed ]
update_catalog: update_catalog:
description: description:
- If you always want to refresh your catalog from the mirror, even when it's not stale, set this to C(yes). - If you always want to refresh your catalog from the mirror, even when it's not stale, set this to C(true).
type: bool type: bool
default: no default: false
force: force:
description: description:
- To allow the update process to downgrade packages to match what is present in the repository, set this to C(yes). - To allow the update process to downgrade packages to match what is present in the repository, set this to C(true).
- This is useful for rolling back to stable from testing, or similar operations. - This is useful for rolling back to stable from testing, or similar operations.
type: bool type: bool
default: false default: false
@ -94,7 +94,7 @@ EXAMPLES = r'''
community.general.pkgutil: community.general.pkgutil:
name: '*' name: '*'
state: latest state: latest
force: yes force: true
''' '''
RETURN = r''' # ''' RETURN = r''' # '''

View file

@ -40,19 +40,19 @@ options:
description: description:
- Update packages to the best version available (--update) - Update packages to the best version available (--update)
type: bool type: bool
default: no default: false
deep: deep:
description: description:
- Consider the entire dependency tree of packages (--deep) - Consider the entire dependency tree of packages (--deep)
type: bool type: bool
default: no default: false
newuse: newuse:
description: description:
- Include installed packages where USE flags have changed (--newuse) - Include installed packages where USE flags have changed (--newuse)
type: bool type: bool
default: no default: false
changed_use: changed_use:
description: description:
@ -60,31 +60,31 @@ options:
- flags that the user has not enabled are added or removed - flags that the user has not enabled are added or removed
- (--changed-use) - (--changed-use)
type: bool type: bool
default: no default: false
oneshot: oneshot:
description: description:
- Do not add the packages to the world file (--oneshot) - Do not add the packages to the world file (--oneshot)
type: bool type: bool
default: no default: false
noreplace: noreplace:
description: description:
- Do not re-emerge installed packages (--noreplace) - Do not re-emerge installed packages (--noreplace)
type: bool type: bool
default: yes default: true
nodeps: nodeps:
description: description:
- Only merge packages but not their dependencies (--nodeps) - Only merge packages but not their dependencies (--nodeps)
type: bool type: bool
default: no default: false
onlydeps: onlydeps:
description: description:
- Only merge packages' dependencies but not the packages (--onlydeps) - Only merge packages' dependencies but not the packages (--onlydeps)
type: bool type: bool
default: no default: false
depclean: depclean:
description: description:
@ -92,25 +92,25 @@ options:
- If no package is specified, clean up the world's dependencies - If no package is specified, clean up the world's dependencies
- Otherwise, --depclean serves as a dependency aware version of --unmerge - Otherwise, --depclean serves as a dependency aware version of --unmerge
type: bool type: bool
default: no default: false
quiet: quiet:
description: description:
- Run emerge in quiet mode (--quiet) - Run emerge in quiet mode (--quiet)
type: bool type: bool
default: no default: false
verbose: verbose:
description: description:
- Run emerge in verbose mode (--verbose) - Run emerge in verbose mode (--verbose)
type: bool type: bool
default: no default: false
sync: sync:
description: description:
- Sync package repositories first - Sync package repositories first
- If yes, perform "emerge --sync" - If C(yes), perform "emerge --sync"
- If web, perform "emerge-webrsync" - If C(web), perform "emerge-webrsync"
choices: [ "web", "yes", "no" ] choices: [ "web", "yes", "no" ]
type: str type: str
@ -118,32 +118,32 @@ options:
description: description:
- Merge only packages specified at C(PORTAGE_BINHOST) in C(make.conf). - Merge only packages specified at C(PORTAGE_BINHOST) in C(make.conf).
type: bool type: bool
default: no default: false
version_added: 1.3.0 version_added: 1.3.0
getbinpkg: getbinpkg:
description: description:
- Prefer packages specified at C(PORTAGE_BINHOST) in C(make.conf). - Prefer packages specified at C(PORTAGE_BINHOST) in C(make.conf).
type: bool type: bool
default: no default: false
usepkgonly: usepkgonly:
description: description:
- Merge only binaries (no compiling). - Merge only binaries (no compiling).
type: bool type: bool
default: no default: false
usepkg: usepkg:
description: description:
- Tries to use the binary package(s) in the locally available packages directory. - Tries to use the binary package(s) in the locally available packages directory.
type: bool type: bool
default: no default: false
keepgoing: keepgoing:
description: description:
- Continue as much as possible after an error. - Continue as much as possible after an error.
type: bool type: bool
default: no default: false
jobs: jobs:
description: description:
@ -165,7 +165,7 @@ options:
- Redirect all build output to logs alone, and do not display it - Redirect all build output to logs alone, and do not display it
- on stdout (--quiet-build) - on stdout (--quiet-build)
type: bool type: bool
default: no default: false
quietfail: quietfail:
description: description:
@ -173,7 +173,7 @@ options:
- Only the die message and the path of the build log will be - Only the die message and the path of the build log will be
- displayed on stdout. - displayed on stdout.
type: bool type: bool
default: no default: false
requirements: [ gentoolkit ] requirements: [ gentoolkit ]
author: author:
@ -196,34 +196,34 @@ EXAMPLES = '''
- name: Update package foo to the latest version (os specific alternative to latest) - name: Update package foo to the latest version (os specific alternative to latest)
community.general.portage: community.general.portage:
package: foo package: foo
update: yes update: true
- name: Install package foo using PORTAGE_BINHOST setup - name: Install package foo using PORTAGE_BINHOST setup
community.general.portage: community.general.portage:
package: foo package: foo
getbinpkg: yes getbinpkg: true
- name: Re-install world from binary packages only and do not allow any compiling - name: Re-install world from binary packages only and do not allow any compiling
community.general.portage: community.general.portage:
package: '@world' package: '@world'
usepkgonly: yes usepkgonly: true
- name: Sync repositories and update world - name: Sync repositories and update world
community.general.portage: community.general.portage:
package: '@world' package: '@world'
update: yes update: true
deep: yes deep: true
sync: yes sync: true
- name: Remove unneeded packages - name: Remove unneeded packages
community.general.portage: community.general.portage:
depclean: yes depclean: true
- name: Remove package foo if it is not explicitly needed - name: Remove package foo if it is not explicitly needed
community.general.portage: community.general.portage:
package: foo package: foo
state: absent state: absent
depclean: yes depclean: true
''' '''
import os import os

View file

@ -37,7 +37,7 @@ options:
- use packages instead of ports whenever available - use packages instead of ports whenever available
type: bool type: bool
required: false required: false
default: yes default: true
author: "berenddeboer (@berenddeboer)" author: "berenddeboer (@berenddeboer)"
''' '''

View file

@ -23,7 +23,7 @@ options:
description: description:
- Whether or not to add the export distributor to new C(rpm) repositories. - Whether or not to add the export distributor to new C(rpm) repositories.
type: bool type: bool
default: no default: false
feed: feed:
description: description:
- Upstream feed URL to receive updates from. - Upstream feed URL to receive updates from.
@ -36,14 +36,14 @@ options:
properly send a 401, logins will fail. This option forces the sending of properly send a 401, logins will fail. This option forces the sending of
the Basic authentication header upon initial request. the Basic authentication header upon initial request.
type: bool type: bool
default: no default: false
generate_sqlite: generate_sqlite:
description: description:
- Boolean flag to indicate whether sqlite files should be generated during - Boolean flag to indicate whether sqlite files should be generated during
a repository publish. a repository publish.
required: false required: false
type: bool type: bool
default: no default: false
feed_ca_cert: feed_ca_cert:
description: description:
- CA certificate string used to validate the feed source SSL certificate. - CA certificate string used to validate the feed source SSL certificate.
@ -120,20 +120,20 @@ options:
repoview: repoview:
description: description:
- Whether to generate repoview files for a published repository. Setting - Whether to generate repoview files for a published repository. Setting
this to "yes" automatically activates C(generate_sqlite). this to C(true) automatically activates C(generate_sqlite).
required: false required: false
type: bool type: bool
default: no default: false
serve_http: serve_http:
description: description:
- Make the repo available over HTTP. - Make the repo available over HTTP.
type: bool type: bool
default: no default: false
serve_https: serve_https:
description: description:
- Make the repo available over HTTPS. - Make the repo available over HTTPS.
type: bool type: bool
default: yes default: true
state: state:
description: description:
- The repo state. A state of C(sync) will queue a sync of the repo. - The repo state. A state of C(sync) will queue a sync of the repo.
@ -152,15 +152,15 @@ options:
- The username for use in HTTP basic authentication to the pulp API. - The username for use in HTTP basic authentication to the pulp API.
validate_certs: validate_certs:
description: description:
- If C(no), SSL certificates will not be validated. This should only be - If C(false), SSL certificates will not be validated. This should only be
used on personally controlled sites using self-signed certificates. used on personally controlled sites using self-signed certificates.
type: bool type: bool
default: yes default: true
wait_for_completion: wait_for_completion:
description: description:
- Wait for asynchronous tasks to complete before returning. - Wait for asynchronous tasks to complete before returning.
type: bool type: bool
default: no default: false
notes: notes:
- This module can currently only create distributors and importers on rpm - This module can currently only create distributors and importers on rpm
repositories. Contributions to support other repo types are welcome. repositories. Contributions to support other repo types are welcome.
@ -183,7 +183,7 @@ EXAMPLES = '''
relative_url: centos/6/updates relative_url: centos/6/updates
url_username: admin url_username: admin
url_password: admin url_password: admin
force_basic_auth: yes force_basic_auth: true
state: present state: present
- name: Remove a repo from the pulp server - name: Remove a repo from the pulp server

View file

@ -138,7 +138,7 @@ options:
description: description:
- Register the system even if it is already registered - Register the system even if it is already registered
type: bool type: bool
default: no default: false
release: release:
description: description:
- Set a release version - Set a release version
@ -173,7 +173,7 @@ options:
RHSM server immediately. When this option is false, then syspurpose attributes RHSM server immediately. When this option is false, then syspurpose attributes
will be synchronized with RHSM server by rhsmcertd daemon. will be synchronized with RHSM server by rhsmcertd daemon.
type: bool type: bool
default: no default: false
''' '''
EXAMPLES = ''' EXAMPLES = '''

View file

@ -54,7 +54,7 @@ options:
description: description:
- Force registration, even if system is already registered. - Force registration, even if system is already registered.
type: bool type: bool
default: no default: false
version_added: 2.0.0 version_added: 2.0.0
ca_cert: ca_cert:
description: description:
@ -73,14 +73,14 @@ options:
default: [] default: []
enable_eus: enable_eus:
description: description:
- If C(no), extended update support will be requested. - If C(false), extended update support will be requested.
type: bool type: bool
default: no default: false
nopackages: nopackages:
description: description:
- If C(yes), the registered node will not upload its installed packages information to Satellite server. - If C(true), the registered node will not upload its installed packages information to Satellite server.
type: bool type: bool
default: no default: false
''' '''
EXAMPLES = r''' EXAMPLES = r'''
@ -100,7 +100,7 @@ EXAMPLES = r'''
community.general.rhn_register: community.general.rhn_register:
state: present state: present
activationkey: 1-222333444 activationkey: 1-222333444
enable_eus: yes enable_eus: true
- name: Register with activationkey and set a profilename which may differ from the hostname - name: Register with activationkey and set a profilename which may differ from the hostname
community.general.rhn_register: community.general.rhn_register:
@ -128,7 +128,7 @@ EXAMPLES = r'''
username: joe_user username: joe_user
password: somepass password: somepass
server_url: https://xmlrpc.my.satellite/XMLRPC server_url: https://xmlrpc.my.satellite/XMLRPC
force: yes force: true
''' '''
RETURN = r''' RETURN = r'''

View file

@ -35,7 +35,7 @@ options:
- The ID of repositories to enable. - The ID of repositories to enable.
- To operate on several repositories this can accept a comma separated - To operate on several repositories this can accept a comma separated
list or a YAML list. list or a YAML list.
required: True required: true
type: list type: list
elements: str elements: str
purge: purge:
@ -44,7 +44,7 @@ options:
Only set this to C(True) if passing in a list of repositories to the C(name) field. Only set this to C(True) if passing in a list of repositories to the C(name) field.
Using this with C(loop) will most likely not have the desired result. Using this with C(loop) will most likely not have the desired result.
type: bool type: bool
default: no default: false
''' '''
EXAMPLES = ''' EXAMPLES = '''

View file

@ -40,7 +40,7 @@ options:
This option can only be specified if there is a single snap in the task. This option can only be specified if there is a single snap in the task.
type: bool type: bool
required: false required: false
default: no default: false
channel: channel:
description: description:
- Define which release of a snap is installed and tracked for updates. - Define which release of a snap is installed and tracked for updates.
@ -104,7 +104,7 @@ EXAMPLES = '''
- name: Install "foo" with option --classic - name: Install "foo" with option --classic
community.general.snap: community.general.snap:
name: foo name: foo
classic: yes classic: true
# Install a snap with from a specific channel # Install a snap with from a specific channel
- name: Install "foo" with option --channel=latest/edge - name: Install "foo" with option --channel=latest/edge

View file

@ -39,7 +39,7 @@ options:
description: description:
- Whether to cast, dispel or rebuild a package - Whether to cast, dispel or rebuild a package
- state C(cast) is an equivalent of C(present), not C(latest) - state C(cast) is an equivalent of C(present), not C(latest)
- state C(latest) always triggers C(update_cache=yes) - state C(latest) always triggers C(update_cache=true)
- state C(rebuild) implies cast of all specified spells, not only - state C(rebuild) implies cast of all specified spells, not only
those existed before those existed before
choices: ["present", "latest", "absent", "cast", "dispelled", "rebuild"] choices: ["present", "latest", "absent", "cast", "dispelled", "rebuild"]
@ -61,13 +61,13 @@ options:
description: description:
- Whether or not to update sorcery scripts at the very first stage - Whether or not to update sorcery scripts at the very first stage
type: bool type: bool
default: no default: false
update_cache: update_cache:
description: description:
- Whether or not to update grimoire collection before casting spells - Whether or not to update grimoire collection before casting spells
type: bool type: bool
default: no default: false
aliases: ["update_codex"] aliases: ["update_codex"]
cache_valid_time: cache_valid_time:
@ -132,17 +132,17 @@ EXAMPLES = '''
community.general.sorcery: community.general.sorcery:
spell: '*' spell: '*'
state: rebuild state: rebuild
update: yes update: true
update_cache: yes update_cache: true
- name: Refresh the grimoire collection if it is 1 day old using native sorcerous alias - name: Refresh the grimoire collection if it is 1 day old using native sorcerous alias
community.general.sorcery: community.general.sorcery:
update_codex: yes update_codex: true
cache_valid_time: 86400 cache_valid_time: 86400
- name: Update only Sorcery itself - name: Update only Sorcery itself
community.general.sorcery: community.general.sorcery:
update: yes update: true
''' '''

View file

@ -71,7 +71,7 @@ options:
EXAMPLES = ''' EXAMPLES = '''
- name: Update the OS to the latest version - name: Update the OS to the latest version
community.general.swupd: community.general.swupd:
update: yes update: true
- name: Installs the "foo" bundle - name: Installs the "foo" bundle
community.general.swupd: community.general.swupd:
@ -85,11 +85,11 @@ EXAMPLES = '''
- name: Check integrity of filesystem - name: Check integrity of filesystem
community.general.swupd: community.general.swupd:
verify: yes verify: true
- name: Downgrade OS to release 12920 - name: Downgrade OS to release 12920
community.general.swupd: community.general.swupd:
verify: yes verify: true
manifest: 12920 manifest: 12920
''' '''

View file

@ -21,7 +21,7 @@ options:
name: name:
description: description:
- A list of package names to install, upgrade or remove. - A list of package names to install, upgrade or remove.
required: yes required: true
aliases: [ package, pkg ] aliases: [ package, pkg ]
type: list type: list
elements: str elements: str
@ -35,18 +35,18 @@ options:
description: description:
- Update the package database first C(urpmi.update -a). - Update the package database first C(urpmi.update -a).
type: bool type: bool
default: no default: false
no_recommends: no_recommends:
description: description:
- Corresponds to the C(--no-recommends) option for I(urpmi). - Corresponds to the C(--no-recommends) option for I(urpmi).
type: bool type: bool
default: yes default: true
force: force:
description: description:
- Assume "yes" is the answer to any question urpmi has to ask. - Assume "yes" is the answer to any question urpmi has to ask.
Corresponds to the C(--force) option for I(urpmi). Corresponds to the C(--force) option for I(urpmi).
type: bool type: bool
default: yes default: true
root: root:
description: description:
- Specifies an alternative install root, relative to which all packages will be installed. - Specifies an alternative install root, relative to which all packages will be installed.
@ -77,7 +77,7 @@ EXAMPLES = '''
- community.general.urpmi: - community.general.urpmi:
name: bar name: bar
state: present state: present
update_cache: yes update_cache: true
''' '''

View file

@ -38,54 +38,68 @@ options:
that they are not required by other packages and were not that they are not required by other packages and were not
explicitly installed by a user. explicitly installed by a user.
type: bool type: bool
default: no default: false
update_cache: update_cache:
description: description:
- Whether or not to refresh the master package lists. This can be - Whether or not to refresh the master package lists. This can be
run as part of a package installation or as a separate step. run as part of a package installation or as a separate step.
type: bool type: bool
default: yes default: true
upgrade: upgrade:
description: description:
- Whether or not to upgrade whole system - Whether or not to upgrade whole system
type: bool type: bool
default: no default: false
upgrade_xbps: upgrade_xbps:
description: description:
- Whether or not to upgrade the xbps package when necessary. - Whether or not to upgrade the xbps package when necessary.
Before installing new packages, Before installing new packages,
xbps requires the user to update the xbps package itself. xbps requires the user to update the xbps package itself.
Thus when this option is set to C(no), Thus when this option is set to C(false),
upgrades and installations will fail when xbps is not up to date. upgrades and installations will fail when xbps is not up to date.
type: bool type: bool
default: yes default: true
version_added: '0.2.0' version_added: '0.2.0'
''' '''
EXAMPLES = ''' EXAMPLES = '''
- name: Install package foo (automatically updating the xbps package if needed) - name: Install package foo (automatically updating the xbps package if needed)
community.general.xbps: name=foo state=present community.general.xbps:
name: foo
state: present
- name: Upgrade package foo - name: Upgrade package foo
community.general.xbps: name=foo state=latest update_cache=yes community.general.xbps:
name: foo
state: latest
update_cache: true
- name: Remove packages foo and bar - name: Remove packages foo and bar
community.general.xbps: name=foo,bar state=absent community.general.xbps:
name:
- foo
- bar
state: absent
- name: Recursively remove package foo - name: Recursively remove package foo
community.general.xbps: name=foo state=absent recurse=yes community.general.xbps:
name: foo
state: absent
recurse: true
- name: Update package cache - name: Update package cache
community.general.xbps: update_cache=yes community.general.xbps:
update_cache: true
- name: Upgrade packages - name: Upgrade packages
community.general.xbps: upgrade=yes community.general.xbps:
upgrade: true
- name: Install a package, failing if the xbps package is out of date - name: Install a package, failing if the xbps package is out of date
community.general.xbps: community.general.xbps:
name: foo name: foo
state: present state: present
upgrade_xbps: no upgrade_xbps: false
''' '''
RETURN = ''' RETURN = '''

View file

@ -73,33 +73,33 @@ options:
signature being installed. Has an effect only if state is signature being installed. Has an effect only if state is
I(present) or I(latest). I(present) or I(latest).
required: false required: false
default: "no" default: false
type: bool type: bool
disable_recommends: disable_recommends:
description: description:
- Corresponds to the C(--no-recommends) option for I(zypper). Default behavior (C(yes)) modifies zypper's default behavior; C(no) does - Corresponds to the C(--no-recommends) option for I(zypper). Default behavior (C(true)) modifies zypper's default behavior; C(false) does
install recommended packages. install recommended packages.
required: false required: false
default: "yes" default: true
type: bool type: bool
force: force:
description: description:
- Adds C(--force) option to I(zypper). Allows to downgrade packages and change vendor or architecture. - Adds C(--force) option to I(zypper). Allows to downgrade packages and change vendor or architecture.
required: false required: false
default: "no" default: false
type: bool type: bool
force_resolution: force_resolution:
description: description:
- Adds C(--force-resolution) option to I(zypper). Allows to (un)install packages with conflicting requirements (resolver will choose a solution). - Adds C(--force-resolution) option to I(zypper). Allows to (un)install packages with conflicting requirements (resolver will choose a solution).
required: false required: false
default: "no" default: false
type: bool type: bool
version_added: '0.2.0' version_added: '0.2.0'
update_cache: update_cache:
description: description:
- Run the equivalent of C(zypper refresh) before the operation. Disabled in check mode. - Run the equivalent of C(zypper refresh) before the operation. Disabled in check mode.
required: false required: false
default: "no" default: false
type: bool type: bool
aliases: [ "refresh" ] aliases: [ "refresh" ]
oldpackage: oldpackage:
@ -107,7 +107,7 @@ options:
- Adds C(--oldpackage) option to I(zypper). Allows to downgrade packages with less side-effects than force. This is implied as soon as a - Adds C(--oldpackage) option to I(zypper). Allows to downgrade packages with less side-effects than force. This is implied as soon as a
version is specified as part of the package name. version is specified as part of the package name.
required: false required: false
default: "no" default: false
type: bool type: bool
extra_args: extra_args:
required: false required: false
@ -156,7 +156,7 @@ EXAMPLES = '''
community.general.zypper: community.general.zypper:
name: apache2 name: apache2
state: present state: present
disable_recommends: no disable_recommends: false
- name: Apply a given patch - name: Apply a given patch
community.general.zypper: community.general.zypper:
@ -207,7 +207,7 @@ EXAMPLES = '''
community.general.zypper: community.general.zypper:
name: openssl name: openssl
state: present state: present
update_cache: yes update_cache: true
- name: "Install specific version (possible comparisons: <, >, <=, >=, =)" - name: "Install specific version (possible comparisons: <, >, <=, >=, =)"
community.general.zypper: community.general.zypper:

View file

@ -44,12 +44,12 @@ options:
I(present). I(present).
- Needs zypper version >= 1.6.2. - Needs zypper version >= 1.6.2.
type: bool type: bool
default: no default: false
autorefresh: autorefresh:
description: description:
- Enable autorefresh of the repository. - Enable autorefresh of the repository.
type: bool type: bool
default: yes default: true
aliases: [ "refresh" ] aliases: [ "refresh" ]
priority: priority:
description: description:
@ -62,7 +62,7 @@ options:
- Overwrite multiple repository entries, if repositories with both name and - Overwrite multiple repository entries, if repositories with both name and
URL already exist. URL already exist.
type: bool type: bool
default: no default: false
auto_import_keys: auto_import_keys:
description: description:
- Automatically import the gpg signing key of the new or changed repository. - Automatically import the gpg signing key of the new or changed repository.
@ -70,18 +70,18 @@ options:
- Implies runrefresh. - Implies runrefresh.
- Only works with C(.repo) files if `name` is given explicitly. - Only works with C(.repo) files if `name` is given explicitly.
type: bool type: bool
default: no default: false
runrefresh: runrefresh:
description: description:
- Refresh the package list of the given repository. - Refresh the package list of the given repository.
- Can be used with repo=* to refresh all repositories. - Can be used with repo=* to refresh all repositories.
type: bool type: bool
default: no default: false
enabled: enabled:
description: description:
- Set repository to enabled (or disabled). - Set repository to enabled (or disabled).
type: bool type: bool
default: yes default: true
requirements: requirements:
@ -109,19 +109,19 @@ EXAMPLES = '''
- name: Refresh all repos - name: Refresh all repos
community.general.zypper_repository: community.general.zypper_repository:
repo: '*' repo: '*'
runrefresh: yes runrefresh: true
- name: Add a repo and add its gpg key - name: Add a repo and add its gpg key
community.general.zypper_repository: community.general.zypper_repository:
repo: 'http://download.opensuse.org/repositories/systemsmanagement/openSUSE_Leap_42.1/' repo: 'http://download.opensuse.org/repositories/systemsmanagement/openSUSE_Leap_42.1/'
auto_import_keys: yes auto_import_keys: true
- name: Force refresh of a repository - name: Force refresh of a repository
community.general.zypper_repository: community.general.zypper_repository:
repo: 'http://my_internal_ci_repo/repo' repo: 'http://my_internal_ci_repo/repo'
name: my_ci_repo name: my_ci_repo
state: present state: present
runrefresh: yes runrefresh: true
''' '''
import traceback import traceback