modules: fix examples to use FQCN (#644)

* modules: fix examples to use FQCN

* fix

* fix

* fix
This commit is contained in:
Andrew Klychkov 2020-07-13 22:50:31 +03:00 committed by GitHub
commit 41cfdda6a3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
533 changed files with 2130 additions and 2130 deletions

View file

@ -48,25 +48,25 @@ options:
EXAMPLES = '''
- name: Install "bootstrap" bower package.
bower:
community.general.bower:
name: bootstrap
- name: Install "bootstrap" bower package on version 3.1.1.
bower:
community.general.bower:
name: bootstrap
version: '3.1.1'
- name: Remove the "bootstrap" bower package.
bower:
community.general.bower:
name: bootstrap
state: absent
- name: Install packages based on bower.json.
bower:
community.general.bower:
path: /app/location
- name: Update packages based on bower.json to their latest version.
bower:
community.general.bower:
path: /app/location
state: latest
@ -75,7 +75,7 @@ EXAMPLES = '''
path: /app/location
name: bower
global: no
- bower:
- community.general.bower:
path: /app/location
relative_execpath: node_modules/.bin
'''

View file

@ -84,27 +84,27 @@ author: "Tim Hoiberg (@thoiberg)"
EXAMPLES = '''
- name: Install gems from a Gemfile in the current directory
bundler:
community.general.bundler:
state: present
executable: ~/.rvm/gems/2.1.5/bin/bundle
- name: Exclude the production group from installing
bundler:
community.general.bundler:
state: present
exclude_groups: production
- name: Install gems into ./vendor/bundle
bundler:
community.general.bundler:
state: present
deployment_mode: yes
- name: Install gems using a Gemfile in another directory
bundler:
community.general.bundler:
state: present
gemfile: ../rails_project/Gemfile
- name: Update Gemfile in another directory
bundler:
community.general.bundler:
state: latest
chdir: ~/rails_project
'''

View file

@ -112,25 +112,25 @@ notes:
EXAMPLES = '''
- name: Download and installs all libs and dependencies outlined in the /path/to/project/composer.lock
composer:
community.general.composer:
command: install
working_dir: /path/to/project
- name: Install a new package
composer:
community.general.composer:
command: require
arguments: my/package
working_dir: /path/to/project
- name: Clone and install a project with all dependencies
composer:
community.general.composer:
command: create-project
arguments: package/package /path/to/project ~1.0
working_dir: /path/to/project
prefer_dist: yes
- name: Install a package globally
composer:
community.general.composer:
command: require
global_command: yes
arguments: my/package

View file

@ -67,40 +67,40 @@ author: "Franck Cuny (@fcuny)"
EXAMPLES = '''
- name: Install Dancer perl package
cpanm:
community.general.cpanm:
name: Dancer
- name: Install version 0.99_05 of the Plack perl package
cpanm:
community.general.cpanm:
name: MIYAGAWA/Plack-0.99_05.tar.gz
- name: Install Dancer into the specified locallib
cpanm:
community.general.cpanm:
name: Dancer
locallib: /srv/webapps/my_app/extlib
- name: Install perl dependencies from local directory
cpanm:
community.general.cpanm:
from_path: /srv/webapps/my_app/src/
- name: Install Dancer perl package without running the unit tests in indicated locallib
cpanm:
community.general.cpanm:
name: Dancer
notest: True
locallib: /srv/webapps/my_app/extlib
- name: Install Dancer perl package from a specific mirror
cpanm:
community.general.cpanm:
name: Dancer
mirror: 'http://cpan.cpantesters.org/'
- name: Install Dancer perl package into the system root path
cpanm:
community.general.cpanm:
name: Dancer
system_lib: yes
- name: Install Dancer if it is not already installed OR the installed version is older than version 1.0
cpanm:
community.general.cpanm:
name: Dancer
version: '1.0'
'''

View file

@ -62,12 +62,12 @@ author: "Matt Wright (@mattupstate)"
EXAMPLES = '''
- name: Install or update pip
easy_install:
community.general.easy_install:
name: pip
state: latest
- name: Install Bottle into the specified virtualenv
easy_install:
community.general.easy_install:
name: bottle
virtualenv: /webapps/myapp/venv
'''

View file

@ -95,18 +95,18 @@ author:
EXAMPLES = '''
- name: Install version 1.0 of vagrant
gem:
community.general.gem:
name: vagrant
version: 1.0
state: present
- name: Install latest available version of rake
gem:
community.general.gem:
name: rake
state: latest
- name: Install rake version 1.0 from a local gem on disk
gem:
community.general.gem:
name: rake
gem_source: /path/to/gems/rake-1.0.gem
state: present

View file

@ -122,20 +122,20 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Download the latest version of the JUnit framework artifact from Maven Central
maven_artifact:
community.general.maven_artifact:
group_id: junit
artifact_id: junit
dest: /tmp/junit-latest.jar
- name: Download JUnit 4.11 from Maven Central
maven_artifact:
community.general.maven_artifact:
group_id: junit
artifact_id: junit
version: 4.11
dest: /tmp/junit-4.11.jar
- name: Download an artifact from a private repository requiring authentication
maven_artifact:
community.general.maven_artifact:
group_id: com.company
artifact_id: library-name
repository_url: 'https://repo.company.com/maven'
@ -144,7 +144,7 @@ EXAMPLES = '''
dest: /tmp/library-name-latest.jar
- name: Download a WAR File to the Tomcat webapps directory to be deployed
maven_artifact:
community.general.maven_artifact:
group_id: com.company
artifact_id: web-app
extension: war
@ -152,7 +152,7 @@ EXAMPLES = '''
dest: /var/lib/tomcat7/webapps/web-app.war
- name: Keep a downloaded artifact's name, i.e. retain the version
maven_artifact:
community.general.maven_artifact:
version: latest
artifact_id: spring-core
group_id: org.springframework
@ -160,14 +160,14 @@ EXAMPLES = '''
keep_name: yes
- name: Download the latest version of the JUnit framework artifact from Maven local
maven_artifact:
community.general.maven_artifact:
group_id: junit
artifact_id: junit
dest: /tmp/junit-latest.jar
repository_url: "file://{{ lookup('env','HOME') }}/.m2/repository"
- name: Download the latest version between 3.8 and 4.0 (exclusive) of the JUnit framework artifact from Maven Central
maven_artifact:
community.general.maven_artifact:
group_id: junit
artifact_id: junit
version_by_spec: "[3.8,4.0)"

View file

@ -82,43 +82,43 @@ requirements:
EXAMPLES = '''
- name: Install "coffee-script" node.js package.
npm:
community.general.npm:
name: coffee-script
path: /app/location
- name: Install "coffee-script" node.js package on version 1.6.1.
npm:
community.general.npm:
name: coffee-script
version: '1.6.1'
path: /app/location
- name: Install "coffee-script" node.js package globally.
npm:
community.general.npm:
name: coffee-script
global: yes
- name: Remove the globally package "coffee-script".
npm:
community.general.npm:
name: coffee-script
global: yes
state: absent
- name: Install "coffee-script" node.js package from custom registry.
npm:
community.general.npm:
name: coffee-script
registry: 'http://registry.mysite.com'
- name: Install packages based on package.json.
npm:
community.general.npm:
path: /app/location
- name: Update packages based on package.json to their latest version.
npm:
community.general.npm:
path: /app/location
state: latest
- name: Install packages based on package.json using the npm installed with nvm v0.10.1.
npm:
community.general.npm:
path: /app/location
executable: /opt/nvm/v0.10.1/bin/npm
state: present

View file

@ -50,24 +50,24 @@ options:
EXAMPLES = r'''
- name: Install pear package
pear:
community.general.pear:
name: Net_URL2
state: present
- name: Install pecl package
pear:
community.general.pear:
name: pecl/json_post
state: present
- name: Install pecl package with expected prompt
pear:
community.general.pear:
name: pecl/apcu
state: present
prompts:
- (.*)Enable internal debugging in APCu \[no\]
- name: Install pecl package with expected prompt and an answer
pear:
community.general.pear:
name: pecl/apcu
state: present
prompts:
@ -77,7 +77,7 @@ EXAMPLES = r'''
Prompts will be processed on the same order as the packages order.
If there is more prompts than packages, packages without prompts will be installed without any prompt expected.
If there is more packages than prompts, additionnal prompts will be ignored.
pear:
community.general.pear:
name: pecl/gnupg, pecl/apcu
state: present
prompts:
@ -88,7 +88,7 @@ EXAMPLES = r'''
Prompts will be processed on the same order as the packages order.
If there is more prompts than packages, packages without prompts will be installed without any prompt expected.
If there is more packages than prompts, additionnal prompts will be ignored.
pear:
community.general.pear:
name: pecl/gnupg, pecl/apcu
state: present
prompts:
@ -96,12 +96,12 @@ EXAMPLES = r'''
- (.*)Enable internal debugging in APCu \[no\]: "yes"
- name: Upgrade package
pear:
community.general.pear:
name: Net_URL2
state: latest
- name: Remove packages
pear:
community.general.pear:
name: Net_URL2,pecl/json_post
state: absent
'''

View file

@ -30,14 +30,14 @@ author:
EXAMPLES = '''
- name: Just get the list from default pip
pip_package_info:
community.general.pip_package_info:
- name: Get the facts for default pip, pip2 and pip3.6
pip_package_info:
community.general.pip_package_info:
clients: ['pip', 'pip2', 'pip3.6']
- name: Get from specific paths (virtualenvs?)
pip_package_info:
community.general.pip_package_info:
clients: '/home/me/projec42/python/pip3.5'
'''

View file

@ -76,38 +76,38 @@ requirements:
EXAMPLES = '''
- name: Install "imagemin" node.js package.
yarn:
community.general.yarn:
name: imagemin
path: /app/location
- name: Install "imagemin" node.js package on version 5.3.1
yarn:
community.general.yarn:
name: imagemin
version: '5.3.1'
path: /app/location
- name: Install "imagemin" node.js package globally.
yarn:
community.general.yarn:
name: imagemin
global: yes
- name: Remove the globally-installed package "imagemin".
yarn:
community.general.yarn:
name: imagemin
global: yes
state: absent
- name: Install "imagemin" node.js package from custom registry.
yarn:
community.general.yarn:
name: imagemin
registry: 'http://registry.mysite.com'
- name: Install packages based on package.json.
yarn:
community.general.yarn:
path: /app/location
- name: Update all packages in package.json to their latest version.
yarn:
community.general.yarn:
path: /app/location
state: latest
'''

View file

@ -68,69 +68,69 @@ notes:
EXAMPLES = '''
- name: Update repositories and install foo package
apk:
community.general.apk:
name: foo
update_cache: yes
- name: Update repositories and install foo and bar packages
apk:
community.general.apk:
name: foo,bar
update_cache: yes
- name: Remove foo package
apk:
community.general.apk:
name: foo
state: absent
- name: Remove foo and bar packages
apk:
community.general.apk:
name: foo,bar
state: absent
- name: Install the package foo
apk:
community.general.apk:
name: foo
state: present
- name: Install the packages foo and bar
apk:
community.general.apk:
name: foo,bar
state: present
- name: Update repositories and update package foo to latest version
apk:
community.general.apk:
name: foo
state: latest
update_cache: yes
- name: Update repositories and update packages foo and bar to latest versions
apk:
community.general.apk:
name: foo,bar
state: latest
update_cache: yes
- name: Update all installed packages to the latest versions
apk:
community.general.apk:
upgrade: yes
- name: Upgrade / replace / downgrade / uninstall all installed packages to the latest versions available
apk:
community.general.apk:
available: yes
upgrade: yes
- name: Update repositories as a separate step
apk:
community.general.apk:
update_cache: yes
- name: Install package from a specific repository
apk:
community.general.apk:
name: foo
state: latest
update_cache: yes
repository: http://dl-3.alpinelinux.org/alpine/edge/main
- name: Install package without using cache
apk:
community.general.apk:
name: foo
state: latest
no_cache: yes

View file

@ -47,18 +47,18 @@ author:
EXAMPLES = '''
- name: Remove all repositories
apt_repo:
community.general.apt_repo:
repo: all
state: absent
- name: Add repository `Sisysphus` and remove other repositories
apt_repo:
community.general.apt_repo:
repo: Sisysphus
state: present
remove_others: yes
- name: Add local repository `/space/ALT/Sisyphus` and update package cache
apt_repo:
community.general.apt_repo:
repo: copy:///space/ALT/Sisyphus
state: present
update: yes

View file

@ -42,30 +42,30 @@ author:
EXAMPLES = '''
- name: Install package foo
apt_rpm:
community.general.apt_rpm:
pkg: foo
state: present
- name: Install packages foo and bar
apt_rpm:
community.general.apt_rpm:
pkg:
- foo
- bar
state: present
- name: Remove package foo
apt_rpm:
community.general.apt_rpm:
pkg: foo
state: absent
- name: Remove packages foo and bar
apt_rpm:
community.general.apt_rpm:
pkg: foo,bar
state: absent
# bar will be the updated if a newer version exists
- name: Update the package database and install bar
apt_rpm:
community.general.apt_rpm:
name: bar
state: present
update_cache: yes

View file

@ -90,29 +90,29 @@ options:
EXAMPLES = r'''
- name: Install the spotify flatpak
flatpak:
community.general.flatpak:
name: https://s3.amazonaws.com/alexlarsson/spotify-repo/spotify.flatpakref
state: present
- name: Install the gedit flatpak package
flatpak:
community.general.flatpak:
name: https://git.gnome.org/browse/gnome-apps-nightly/plain/gedit.flatpakref
state: present
- name: Install the gedit package from flathub for current user
flatpak:
community.general.flatpak:
name: org.gnome.gedit
state: present
method: user
- name: Install the Gnome Calendar flatpak from the gnome remote system-wide
flatpak:
community.general.flatpak:
name: org.gnome.Calendar
state: present
remote: gnome
- name: Remove the gedit flatpak
flatpak:
community.general.flatpak:
name: org.gnome.gedit
state: absent
'''

View file

@ -87,26 +87,26 @@ options:
EXAMPLES = r'''
- name: Add the Gnome flatpak remote to the system installation
flatpak_remote:
community.general.flatpak_remote:
name: gnome
state: present
flatpakrepo_url: https://sdk.gnome.org/gnome-apps.flatpakrepo
- name: Add the flathub flatpak repository remote to the user installation
flatpak_remote:
community.general.flatpak_remote:
name: flathub
state: present
flatpakrepo_url: https://dl.flathub.org/repo/flathub.flatpakrepo
method: user
- name: Remove the Gnome flatpak remote from the user installation
flatpak_remote:
community.general.flatpak_remote:
name: gnome
state: absent
method: user
- name: Remove the flathub remote from the system installation
flatpak_remote:
community.general.flatpak_remote:
name: flathub
state: absent
'''

View file

@ -77,57 +77,57 @@ notes:
EXAMPLES = '''
# Install formula foo with 'brew' in default path (C(/usr/local/bin))
- homebrew:
- community.general.homebrew:
name: foo
state: present
# Install formula foo with 'brew' in alternate path C(/my/other/location/bin)
- homebrew:
- community.general.homebrew:
name: foo
path: /my/other/location/bin
state: present
# Update homebrew first and install formula foo with 'brew' in default path
- homebrew:
- community.general.homebrew:
name: foo
state: present
update_homebrew: yes
# Update homebrew first and upgrade formula foo to latest available with 'brew' in default path
- homebrew:
- community.general.homebrew:
name: foo
state: latest
update_homebrew: yes
# Update homebrew and upgrade all packages
- homebrew:
- community.general.homebrew:
update_homebrew: yes
upgrade_all: yes
# Miscellaneous other examples
- homebrew:
- community.general.homebrew:
name: foo
state: head
- homebrew:
- community.general.homebrew:
name: foo
state: linked
- homebrew:
- community.general.homebrew:
name: foo
state: absent
- homebrew:
- community.general.homebrew:
name: foo,bar
state: absent
- homebrew:
- community.general.homebrew:
name: foo
state: present
install_options: with-baz,enable-debug
- name: Use ignored-pinned option while upgrading all
homebrew:
community.general.homebrew:
upgrade_all: yes
upgrade_options: ignored-pinned
'''

View file

@ -80,57 +80,57 @@ options:
'''
EXAMPLES = '''
- name: Install cask
homebrew_cask:
community.general.homebrew_cask:
name: alfred
state: present
- name: Remove cask
homebrew_cask:
community.general.homebrew_cask:
name: alfred
state: absent
- name: Install cask with install options
homebrew_cask:
community.general.homebrew_cask:
name: alfred
state: present
install_options: 'appdir=/Applications'
- name: Install cask with install options
homebrew_cask:
community.general.homebrew_cask:
name: alfred
state: present
install_options: 'debug,appdir=/Applications'
- name: Allow external app
homebrew_cask:
community.general.homebrew_cask:
name: alfred
state: present
accept_external_apps: True
- name: Remove cask with force option
homebrew_cask:
community.general.homebrew_cask:
name: alfred
state: absent
install_options: force
- name: Upgrade all casks
homebrew_cask:
community.general.homebrew_cask:
upgrade_all: true
- name: Upgrade given cask with force option
homebrew_cask:
community.general.homebrew_cask:
name: alfred
state: upgraded
install_options: force
- name: Upgrade cask with greedy option
homebrew_cask:
community.general.homebrew_cask:
name: 1password
state: upgraded
greedy: True
- name: Using sudo password for installing cask
homebrew_cask:
community.general.homebrew_cask:
name: wireshark
state: present
sudo_password: "{{ ansible_become_pass }}"

View file

@ -50,21 +50,21 @@ requirements: [ homebrew ]
EXAMPLES = '''
- name: Tap a Homebrew repository, state present
homebrew_tap:
community.general.homebrew_tap:
name: homebrew/dupes
- name: Tap a Homebrew repository, state absent
homebrew_tap:
community.general.homebrew_tap:
name: homebrew/dupes
state: absent
- name: Tap a Homebrew repository, state present
homebrew_tap:
community.general.homebrew_tap:
name: homebrew/dupes,homebrew/science
state: present
- name: Tap a Homebrew repository using url, state present
homebrew_tap:
community.general.homebrew_tap:
name: telemachus/brew
url: 'https://bitbucket.org/telemachus/brew'
'''

View file

@ -45,35 +45,35 @@ notes:
EXAMPLES = r'''
- name: Install package foo
installp:
community.general.installp:
name: foo
repository_path: /repository/AIX71/installp/base
accept_license: yes
state: present
- name: Install bos.sysmgt that includes bos.sysmgt.nim.master, bos.sysmgt.nim.spot
installp:
community.general.installp:
name: bos.sysmgt
repository_path: /repository/AIX71/installp/base
accept_license: yes
state: present
- name: Install bos.sysmgt.nim.master only
installp:
community.general.installp:
name: bos.sysmgt.nim.master
repository_path: /repository/AIX71/installp/base
accept_license: yes
state: present
- name: Install bos.sysmgt.nim.master and bos.sysmgt.nim.spot
installp:
community.general.installp:
name: bos.sysmgt.nim.master, bos.sysmgt.nim.spot
repository_path: /repository/AIX71/installp/base
accept_license: yes
state: present
- name: Remove packages bos.sysmgt.nim.master
installp:
community.general.installp:
name: bos.sysmgt.nim.master
state: absent
'''

View file

@ -51,27 +51,27 @@ options:
EXAMPLES = '''
- name: Install the overlay mozilla which is on the central overlays list
layman:
community.general.layman:
name: mozilla
- name: Install the overlay cvut from the specified alternative list
layman:
community.general.layman:
name: cvut
list_url: 'http://raw.github.com/cvut/gentoo-overlay/master/overlay.xml'
- name: Update (sync) the overlay cvut or install if not installed yet
layman:
community.general.layman:
name: cvut
list_url: 'http://raw.github.com/cvut/gentoo-overlay/master/overlay.xml'
state: updated
- name: Update (sync) all of the installed overlays
layman:
community.general.layman:
name: ALL
state: updated
- name: Uninstall the overlay cvut
layman:
community.general.layman:
name: cvut
state: absent
'''

View file

@ -53,16 +53,16 @@ options:
'''
EXAMPLES = '''
- name: Install the foo port
macports:
community.general.macports:
name: foo
- name: Install the universal, x11 variant of the foo port
macports:
community.general.macports:
name: foo
variant: +universal+x11
- name: Install a list of ports
macports:
community.general.macports:
name: "{{ ports }}"
vars:
ports:
@ -70,27 +70,27 @@ EXAMPLES = '''
- foo-tools
- name: Update Macports and the ports tree, then upgrade all outdated ports
macports:
community.general.macports:
selfupdate: yes
upgrade: yes
- name: Update Macports and the ports tree, then install the foo port
macports:
community.general.macports:
name: foo
selfupdate: yes
- name: Remove the foo port
macports:
community.general.macports:
name: foo
state: absent
- name: Activate the foo port
macports:
community.general.macports:
name: foo
state: active
- name: Deactivate the foo port
macports:
community.general.macports:
name: foo
state: inactive
'''

View file

@ -51,28 +51,28 @@ notes:
EXAMPLES = '''
- name: Install Keynote
mas:
community.general.mas:
id: 409183694
state: present
- name: Install a list of apps
mas:
community.general.mas:
id:
- 409183694 # Keynote
- 413857545 # Divvy
state: present
- name: Ensure the latest Keynote version is installed
mas:
community.general.mas:
id: 409183694
state: latest
- name: Upgrade all installed Mac App Store apps
mas:
community.general.mas:
upgrade_all: yes
- name: Install specific apps and also upgrade all others
mas:
community.general.mas:
id:
- 409183694 # Keynote
- 413857545 # Divvy
@ -80,7 +80,7 @@ EXAMPLES = '''
upgrade_all: yes
- name: Uninstall Divvy
mas:
community.general.mas:
id: 413857545
state: absent
become: yes # Uninstallation requires root permissions

View file

@ -68,54 +68,54 @@ notes:
EXAMPLES = '''
- name: Make sure nmap is installed
openbsd_pkg:
community.general.openbsd_pkg:
name: nmap
state: present
- name: Make sure nmap is the latest version
openbsd_pkg:
community.general.openbsd_pkg:
name: nmap
state: latest
- name: Make sure nmap is not installed
openbsd_pkg:
community.general.openbsd_pkg:
name: nmap
state: absent
- name: Make sure nmap is installed, build it from source if it is not
openbsd_pkg:
community.general.openbsd_pkg:
name: nmap
state: present
build: yes
- name: Specify a pkg flavour with '--'
openbsd_pkg:
community.general.openbsd_pkg:
name: vim--no_x11
state: present
- name: Specify the default flavour to avoid ambiguity errors
openbsd_pkg:
community.general.openbsd_pkg:
name: vim--
state: present
- name: Specify a package branch (requires at least OpenBSD 6.0)
openbsd_pkg:
community.general.openbsd_pkg:
name: python%3.5
state: present
- name: Update all packages on the system
openbsd_pkg:
community.general.openbsd_pkg:
name: '*'
state: latest
- name: Purge a package and it's configuration files
openbsd_pkg:
community.general.openbsd_pkg:
name: mpd
clean: yes
state: absent
- name: Quickly remove a package without checking checksums
openbsd_pkg:
community.general.openbsd_pkg:
name: qt5
quick: yes
state: absent

View file

@ -59,28 +59,28 @@ requirements:
'''
EXAMPLES = '''
- name: Install foo
opkg:
community.general.opkg:
name: foo
state: present
- name: Update cache and install foo
opkg:
community.general.opkg:
name: foo
state: present
update_cache: yes
- name: Remove foo
opkg:
community.general.opkg:
name: foo
state: absent
- name: Remove foo and bar
opkg:
community.general.opkg:
name: foo,bar
state: absent
- name: Install foo using overwrite option forcibly
opkg:
community.general.opkg:
name: foo
state: present
force: overwrite

View file

@ -92,56 +92,56 @@ packages:
EXAMPLES = '''
- name: Install package foo from repo
pacman:
community.general.pacman:
name: foo
state: present
- name: Install package bar from file
pacman:
community.general.pacman:
name: ~/bar-1.0-1-any.pkg.tar.xz
state: present
- name: Install package foo from repo and bar from file
pacman:
community.general.pacman:
name:
- foo
- ~/bar-1.0-1-any.pkg.tar.xz
state: present
- name: Upgrade package foo
pacman:
community.general.pacman:
name: foo
state: latest
update_cache: yes
- name: Remove packages foo and bar
pacman:
community.general.pacman:
name:
- foo
- bar
state: absent
- name: Recursively remove package baz
pacman:
community.general.pacman:
name: baz
state: absent
extra_args: --recursive
- name: Run the equivalent of "pacman -Sy" as a separate step
pacman:
community.general.pacman:
update_cache: yes
- name: Run the equivalent of "pacman -Su" as a separate step
pacman:
community.general.pacman:
upgrade: yes
- name: Run the equivalent of "pacman -Syu" as a separate step
pacman:
community.general.pacman:
update_cache: yes
upgrade: yes
- name: Run the equivalent of "pacman -Rdd", force remove package baz
pacman:
community.general.pacman:
name: baz
state: absent
force: yes

View file

@ -49,21 +49,21 @@ options:
'''
EXAMPLES = '''
- name: Install Vim
pkg5:
community.general.pkg5:
name: editor/vim
- name: Install Vim without refreshing publishers
pkg5:
community.general.pkg5:
name: editor/vim
refresh: no
- name: Remove finger daemon
pkg5:
community.general.pkg5:
name: service/network/finger
state: absent
- name: Install several packages at once
pkg5:
community.general.pkg5:
name:
- /file/gnu-findutils
- /text/gnu-grep

View file

@ -55,13 +55,13 @@ options:
'''
EXAMPLES = '''
- name: Fetch packages for the solaris publisher direct from Oracle
pkg5_publisher:
community.general.pkg5_publisher:
name: solaris
sticky: true
origin: https://pkg.oracle.com/solaris/support/
- name: Configure a publisher for locally-produced packages
pkg5_publisher:
community.general.pkg5_publisher:
name: site
origin: 'https://pkg.example.com/site/'
'''

View file

@ -73,44 +73,44 @@ options:
EXAMPLES = '''
- name: Install package foo
pkgin:
community.general.pkgin:
name: foo
state: present
- name: Update cache and install foo package
pkgin:
community.general.pkgin:
name: foo
update_cache: yes
- name: Remove package foo
pkgin:
community.general.pkgin:
name: foo
state: absent
- name: Remove packages foo and bar
pkgin:
community.general.pkgin:
name: foo,bar
state: absent
- name: Update repositories as a separate step
pkgin:
community.general.pkgin:
update_cache: yes
- name: Upgrade main packages (equivalent to pkgin upgrade)
pkgin:
community.general.pkgin:
upgrade: yes
- name: Upgrade all packages (equivalent to pkgin full-upgrade)
pkgin:
community.general.pkgin:
full_upgrade: yes
- name: Force-upgrade all packages (equivalent to pkgin -F full-upgrade)
pkgin:
community.general.pkgin:
full_upgrade: yes
force: yes
- name: Clean packages cache (equivalent to pkgin clean)
pkgin:
community.general.pkgin:
clean: yes
'''

View file

@ -99,28 +99,28 @@ notes:
EXAMPLES = '''
- name: Install package foo
pkgng:
community.general.pkgng:
name: foo
state: present
- name: Annotate package foo and bar
pkgng:
community.general.pkgng:
name: foo,bar
annotation: '+test1=baz,-test2,:test3=foobar'
- name: Remove packages foo and bar
pkgng:
community.general.pkgng:
name: foo,bar
state: absent
# "latest" support added in 2.7
- name: Upgrade package baz
pkgng:
community.general.pkgng:
name: baz
state: latest
- name: Upgrade all installed packages (see warning for the name option first!)
pkgng:
community.general.pkgng:
name: "*"
state: latest
'''

View file

@ -52,12 +52,12 @@ options:
EXAMPLES = '''
- name: Install a package
pkgutil:
community.general.pkgutil:
name: CSWcommon
state: present
- name: Install a package from a specific repository
pkgutil:
community.general.pkgutil:
name: CSWnrpe
site: 'ftp://myinternal.repo/opencsw/kiel'
state: latest

View file

@ -176,43 +176,43 @@ author:
EXAMPLES = '''
- name: Make sure package foo is installed
portage:
community.general.portage:
package: foo
state: present
- name: Make sure package foo is not installed
portage:
community.general.portage:
package: foo
state: absent
- name: Update package foo to the latest version (os specific alternative to latest)
portage:
community.general.portage:
package: foo
update: yes
- name: Install package foo using PORTAGE_BINHOST setup
portage:
community.general.portage:
package: foo
getbinpkg: yes
- name: Re-install world from binary packages only and do not allow any compiling
portage:
community.general.portage:
package: '@world'
usepkgonly: yes
- name: Sync repositories and update world
portage:
community.general.portage:
package: '@world'
update: yes
deep: yes
sync: yes
- name: Remove unneeded packages
portage:
community.general.portage:
depclean: yes
- name: Remove package foo if it is not explicitly needed
portage:
community.general.portage:
package: foo
state: absent
depclean: yes

View file

@ -42,17 +42,17 @@ author: "berenddeboer (@berenddeboer)"
EXAMPLES = '''
- name: Install package foo
portinstall:
community.general.portinstall:
name: foo
state: present
- name: Install package security/cyrus-sasl2-saslauthd
portinstall:
community.general.portinstall:
name: security/cyrus-sasl2-saslauthd
state: present
- name: Remove packages foo and bar
portinstall:
community.general.portinstall:
name: foo,bar
state: absent
'''

View file

@ -173,13 +173,13 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: Create a new repo with name 'my_repo'
pulp_repo:
community.general.pulp_repo:
name: my_repo
relative_url: my/repo
state: present
- name: Create a repo with a feed and a relative URL
pulp_repo:
community.general.pulp_repo:
name: my_centos_updates
repo_type: rpm
feed: http://mirror.centos.org/centos/6/updates/x86_64/
@ -190,7 +190,7 @@ EXAMPLES = '''
state: present
- name: Remove a repo from the pulp server
pulp_repo:
community.general.pulp_repo:
name: my_old_repo
repo_type: rpm
state: absent

View file

@ -165,21 +165,21 @@ options:
EXAMPLES = '''
- name: Register as user (joe_user) with password (somepass) and auto-subscribe to available content.
redhat_subscription:
community.general.redhat_subscription:
state: present
username: joe_user
password: somepass
auto_attach: true
- name: Same as above but subscribe to a specific pool by ID.
redhat_subscription:
community.general.redhat_subscription:
state: present
username: joe_user
password: somepass
pool_ids: 0123456789abcdef0123456789abcdef
- name: Register and subscribe to multiple pools.
redhat_subscription:
community.general.redhat_subscription:
state: present
username: joe_user
password: somepass
@ -188,7 +188,7 @@ EXAMPLES = '''
- 1123456789abcdef0123456789abcdef
- name: Same as above but consume multiple entitlements.
redhat_subscription:
community.general.redhat_subscription:
state: present
username: joe_user
password: somepass
@ -197,28 +197,28 @@ EXAMPLES = '''
- 1123456789abcdef0123456789abcdef: 4
- name: Register and pull existing system data.
redhat_subscription:
community.general.redhat_subscription:
state: present
username: joe_user
password: somepass
consumer_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
- name: Register with activationkey and consume subscriptions matching Red Hat Enterprise Server or Red Hat Virtualization
redhat_subscription:
community.general.redhat_subscription:
state: present
activationkey: 1-222333444
org_id: 222333444
pool: '^(Red Hat Enterprise Server|Red Hat Virtualization)$'
- name: Update the consumed subscriptions from the previous example (remove Red Hat Virtualization subscription)
redhat_subscription:
community.general.redhat_subscription:
state: present
activationkey: 1-222333444
org_id: 222333444
pool: '^Red Hat Enterprise Server$'
- name: Register as user credentials into given environment (against Red Hat Satellite 6.x), and auto-subscribe.
redhat_subscription:
community.general.redhat_subscription:
state: present
username: joe_user
password: somepass
@ -226,14 +226,14 @@ EXAMPLES = '''
auto_attach: true
- name: Register as user (joe_user) with password (somepass) and a specific release
redhat_subscription:
community.general.redhat_subscription:
state: present
username: joe_user
password: somepass
release: 7.4
- name: Register as user (joe_user) with password (somepass), set syspurpose attributes and synchronize them with server
redhat_subscription:
community.general.redhat_subscription:
state: present
username: joe_user
password: somepass

View file

@ -62,7 +62,7 @@ options:
EXAMPLES = '''
- name: Add a Red Hat software channel
rhn_channel:
community.general.rhn_channel:
name: rhel-x86_64-server-v2vwin-6
sysname: server01
url: https://rhn.redhat.com/rpc/api

View file

@ -78,38 +78,38 @@ options:
EXAMPLES = r'''
- name: Unregister system from RHN
rhn_register:
community.general.rhn_register:
state: absent
username: joe_user
password: somepass
- name: Register as user with password and auto-subscribe to available content
rhn_register:
community.general.rhn_register:
state: present
username: joe_user
password: somepass
- name: Register with activationkey and enable extended update support
rhn_register:
community.general.rhn_register:
state: present
activationkey: 1-222333444
enable_eus: yes
- name: Register with activationkey and set a profilename which may differ from the hostname
rhn_register:
community.general.rhn_register:
state: present
activationkey: 1-222333444
profilename: host.example.com.custom
- name: Register as user with password against a satellite server
rhn_register:
community.general.rhn_register:
state: present
username: joe_user
password: somepass
server_url: https://xmlrpc.my.satellite/XMLRPC
- name: Register as user with password and enable channels
rhn_register:
community.general.rhn_register:
state: present
username: joe_user
password: somepass

View file

@ -31,17 +31,17 @@ author:
EXAMPLES = '''
# Set release version to 7.1
- name: Set RHSM release version
rhsm_release:
community.general.rhsm_release:
release: "7.1"
# Set release version to 6Server
- name: Set RHSM release version
rhsm_release:
community.general.rhsm_release:
release: "6Server"
# Unset release version
- name: Unset RHSM release release
rhsm_release:
community.general.rhsm_release:
release: null
'''

View file

@ -47,21 +47,21 @@ options:
EXAMPLES = '''
- name: Enable a RHSM repository
rhsm_repository:
community.general.rhsm_repository:
name: rhel-7-server-rpms
- name: Disable all RHSM repositories
rhsm_repository:
community.general.rhsm_repository:
name: '*'
state: disabled
- name: Enable all repositories starting with rhel-6-server
rhsm_repository:
community.general.rhsm_repository:
name: rhel-6-server*
state: enabled
- name: Disable all repositories except rhel-7-server-rpms
rhsm_repository:
community.general.rhsm_repository:
name: rhel-7-server-rpms
purge: True
'''

View file

@ -52,17 +52,17 @@ requirements: [ "Slackware >= 12.2" ]
EXAMPLES = '''
- name: Install package foo
slackpkg:
community.general.slackpkg:
name: foo
state: present
- name: Remove packages foo and bar
slackpkg:
community.general.slackpkg:
name: foo,bar
state: absent
- name: Make sure that it is the most updated package
slackpkg:
community.general.slackpkg:
name: foo
state: latest
'''

View file

@ -58,26 +58,26 @@ author:
EXAMPLES = '''
# Install "foo" and "bar" snap
- name: Install foo
snap:
community.general.snap:
name:
- foo
- bar
# Remove "foo" snap
- name: Remove foo
snap:
community.general.snap:
name: foo
state: absent
# Install a snap with classic confinement
- name: Install "foo" with option --classic
snap:
community.general.snap:
name: foo
classic: yes
# Install a snap with from a specific channel
- name: Install "foo" with option --channel=latest/edge
snap:
community.general.snap:
name: foo
channel: latest/edge
'''

View file

@ -80,35 +80,35 @@ options:
EXAMPLES = '''
- name: Make sure spell foo is installed
sorcery:
community.general.sorcery:
spell: foo
state: present
- name: Make sure spells foo, bar and baz are removed
sorcery:
community.general.sorcery:
spell: foo,bar,baz
state: absent
- name: Make sure spell foo with dependencies bar and baz is installed
sorcery:
community.general.sorcery:
spell: foo
depends: bar,baz
state: present
- name: Make sure spell foo with bar and without baz dependencies is installed
sorcery:
community.general.sorcery:
spell: foo
depends: +bar,-baz
state: present
- name: Make sure spell foo with libressl (providing SSL) dependency is installed
sorcery:
community.general.sorcery:
spell: foo
depends: libressl(SSL)
state: present
- name: Make sure spells with/without required dependencies (if any) are installed
sorcery:
community.general.sorcery:
name: "{{ item.spell }}"
depends: "{{ item.depends | default(None) }}"
state: present
@ -118,29 +118,29 @@ EXAMPLES = '''
- { spell: 'pv,tnftp,tor' }
- name: Install the latest version of spell foo using regular glossary
sorcery:
community.general.sorcery:
name: foo
state: latest
- name: Rebuild spell foo
sorcery:
community.general.sorcery:
spell: foo
state: rebuild
- name: Rebuild the whole system, but update Sorcery and Codex first
sorcery:
community.general.sorcery:
spell: '*'
state: rebuild
update: yes
update_cache: yes
- name: Refresh the grimoire collection if it is 1 day old using native sorcerous alias
sorcery:
community.general.sorcery:
update_codex: yes
cache_valid_time: 86400
- name: Update only Sorcery itself
sorcery:
community.general.sorcery:
update: yes
'''

View file

@ -68,32 +68,32 @@ options:
EXAMPLES = '''
- name: Install a package from an already copied file
svr4pkg:
community.general.svr4pkg:
name: CSWcommon
src: /tmp/cswpkgs.pkg
state: present
- name: Install a package directly from an http site
svr4pkg:
community.general.svr4pkg:
name: CSWpkgutil
src: 'http://get.opencsw.org/now'
state: present
zone: current
- name: Install a package with a response file
svr4pkg:
community.general.svr4pkg:
name: CSWggrep
src: /tmp/third-party.pkg
response_file: /tmp/ggrep.response
state: present
- name: Ensure that a package is not installed
svr4pkg:
community.general.svr4pkg:
name: SUNWgnome-sound-recorder
state: absent
- name: Ensure that a category is not installed
svr4pkg:
community.general.svr4pkg:
name: FIREFOX
state: absent
category: true

View file

@ -40,19 +40,19 @@ options:
EXAMPLES = '''
- name: Install a package
swdepot:
community.general.swdepot:
name: unzip-6.0
state: present
depot: 'repository:/path'
- name: Install the latest version of a package
swdepot:
community.general.swdepot:
name: unzip
state: latest
depot: 'repository:/path'
- name: Remove a package
swdepot:
community.general.swdepot:
name: unzip
state: absent
'''

View file

@ -66,25 +66,25 @@ options:
EXAMPLES = '''
- name: Update the OS to the latest version
swupd:
community.general.swupd:
update: yes
- name: Installs the "foo" bundle
swupd:
community.general.swupd:
name: foo
state: present
- name: Removes the "foo" bundle
swupd:
community.general.swupd:
name: foo
state: absent
- name: Check integrity of filesystem
swupd:
community.general.swupd:
verify: yes
- name: Downgrade OS to release 12920
swupd:
community.general.swupd:
verify: yes
manifest: 12920
'''

View file

@ -60,22 +60,22 @@ author:
EXAMPLES = '''
- name: Install package foo
urpmi:
community.general.urpmi:
pkg: foo
state: present
- name: Remove package foo
urpmi:
community.general.urpmi:
pkg: foo
state: absent
- name: Remove packages foo and bar
urpmi:
community.general.urpmi:
pkg: foo,bar
state: absent
- name: Update the package database (urpmi.update -a -q) and install bar (bar will be the updated if a newer version exists)
- urpmi:
- community.general.urpmi:
name: bar
state: present
update_cache: yes

View file

@ -70,25 +70,25 @@ options:
EXAMPLES = '''
- name: Install package foo (automatically updating the xbps package if needed)
xbps: name=foo state=present
community.general.xbps: name=foo state=present
- name: Upgrade package foo
xbps: name=foo state=latest update_cache=yes
community.general.xbps: name=foo state=latest update_cache=yes
- name: Remove packages foo and bar
xbps: name=foo,bar state=absent
community.general.xbps: name=foo,bar state=absent
- name: Recursively remove package foo
xbps: name=foo state=absent recurse=yes
community.general.xbps: name=foo state=absent recurse=yes
- name: Update package cache
xbps: update_cache=yes
community.general.xbps: update_cache=yes
- name: Upgrade packages
xbps: upgrade=yes
community.general.xbps: upgrade=yes
- name: Install a package, failing if the xbps package is out of date
xbps:
community.general.xbps:
name: foo
state: present
upgrade_xbps: no

View file

@ -139,74 +139,74 @@ requirements:
EXAMPLES = '''
- name: Install nmap
zypper:
community.general.zypper:
name: nmap
state: present
- name: Install apache2 with recommended packages
zypper:
community.general.zypper:
name: apache2
state: present
disable_recommends: no
- name: Apply a given patch
zypper:
community.general.zypper:
name: openSUSE-2016-128
state: present
type: patch
- name: Remove the nmap package
zypper:
community.general.zypper:
name: nmap
state: absent
- name: Install the nginx rpm from a remote repo
zypper:
community.general.zypper:
name: 'http://nginx.org/packages/sles/12/x86_64/RPMS/nginx-1.8.0-1.sles12.ngx.x86_64.rpm'
state: present
- name: Install local rpm file
zypper:
community.general.zypper:
name: /tmp/fancy-software.rpm
state: present
- name: Update all packages
zypper:
community.general.zypper:
name: '*'
state: latest
- name: Apply all available patches
zypper:
community.general.zypper:
name: '*'
state: latest
type: patch
- name: Perform a dist-upgrade with additional arguments
zypper:
community.general.zypper:
name: '*'
state: dist-upgrade
allow_vendor_change: true
extra_args: '--allow-arch-change'
- name: Perform a installaion of nmap with the install option replacefiles
zypper:
community.general.zypper:
name: 'nmap'
state: latest
replacefiles: true
- name: Refresh repositories and update package openssl
zypper:
community.general.zypper:
name: openssl
state: present
update_cache: yes
- name: "Install specific version (possible comparisons: <, >, <=, >=, =)"
zypper:
community.general.zypper:
name: 'docker>=1.10'
state: present
- name: Wait 20 seconds to acquire the lock before failing
zypper:
community.general.zypper:
name: mosh
state: present
environment:

View file

@ -90,33 +90,33 @@ requirements:
EXAMPLES = '''
- name: Add NVIDIA repository for graphics drivers
zypper_repository:
community.general.zypper_repository:
name: nvidia-repo
repo: 'ftp://download.nvidia.com/opensuse/12.2'
state: present
- name: Remove NVIDIA repository
zypper_repository:
community.general.zypper_repository:
name: nvidia-repo
repo: 'ftp://download.nvidia.com/opensuse/12.2'
state: absent
- name: Add python development repository
zypper_repository:
community.general.zypper_repository:
repo: 'http://download.opensuse.org/repositories/devel:/languages:/python/SLE_11_SP3/devel:languages:python.repo'
- name: Refresh all repos
zypper_repository:
community.general.zypper_repository:
repo: '*'
runrefresh: yes
- name: Add a repo and add its gpg key
zypper_repository:
community.general.zypper_repository:
repo: 'http://download.opensuse.org/repositories/systemsmanagement/openSUSE_Leap_42.1/'
auto_import_keys: yes
- name: Force refresh of a repository
zypper_repository:
community.general.zypper_repository:
repo: 'http://my_internal_ci_repo/repo'
name: my_ci_repo
state: present