mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-24 05:40:23 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -29,21 +29,16 @@ options:
|
|||
description:
|
||||
- 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.
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.4"
|
||||
name:
|
||||
description:
|
||||
- A package name, like C(foo), or multiple packages, like C(foo, bar).
|
||||
required: false
|
||||
default: null
|
||||
repository:
|
||||
description:
|
||||
- A package repository or multiple repositories.
|
||||
Unlike with the underlying apk command, this list will override the system repositories rather than supplement them.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.4"
|
||||
state:
|
||||
description:
|
||||
|
@ -51,21 +46,18 @@ options:
|
|||
- C(present) ensures the package(s) is/are present.
|
||||
- C(absent) ensures the package(s) is/are absent.
|
||||
- C(latest) ensures the package(s) is/are present and the latest version(s).
|
||||
required: false
|
||||
default: present
|
||||
choices: [ "present", "absent", "latest" ]
|
||||
update_cache:
|
||||
description:
|
||||
- Update repository indexes. Can be run with other steps or on it's own.
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
upgrade:
|
||||
description:
|
||||
- Upgrade all installed packages to their latest version.
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
notes:
|
||||
- '"name" and "upgrade" are mutually exclusive.'
|
||||
- When used with a `loop:` each package will be processed individually, it is much more efficient to pass the list directly to the `name` option.
|
||||
|
|
|
@ -29,19 +29,14 @@ options:
|
|||
When using state=latest, this can be '*' which means run: dnf -y update.
|
||||
You can also pass a url or a local path to a rpm file."
|
||||
required: true
|
||||
default: null
|
||||
aliases: []
|
||||
|
||||
list:
|
||||
description:
|
||||
- Various (non-idempotent) commands for usage with C(/usr/bin/ansible) and I(not) playbooks. See examples.
|
||||
required: false
|
||||
default: null
|
||||
|
||||
state:
|
||||
description:
|
||||
- Whether to install (C(present), C(latest)), or remove (C(absent)) a package.
|
||||
required: false
|
||||
choices: [ "present", "latest", "absent" ]
|
||||
default: "present"
|
||||
|
||||
|
@ -50,40 +45,28 @@ options:
|
|||
- I(Repoid) of repositories to enable for the install/update operation.
|
||||
These repos will not persist beyond the transaction.
|
||||
When specifying multiple repos, separate them with a ",".
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
|
||||
disablerepo:
|
||||
description:
|
||||
- I(Repoid) of repositories to disable for the install/update operation.
|
||||
These repos will not persist beyond the transaction.
|
||||
When specifying multiple repos, separate them with a ",".
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
|
||||
conf_file:
|
||||
description:
|
||||
- The remote dnf configuration file to use for the transaction.
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
|
||||
disable_gpg_check:
|
||||
description:
|
||||
- Whether to disable the GPG checking of signatures of packages being
|
||||
installed. Has an effect only if state is I(present) or I(latest).
|
||||
required: false
|
||||
default: "no"
|
||||
choices: ["yes", "no"]
|
||||
aliases: []
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
installroot:
|
||||
description:
|
||||
- Specifies an alternative installroot, relative to which all packages
|
||||
will be installed.
|
||||
required: false
|
||||
version_added: "2.3"
|
||||
default: "/"
|
||||
|
||||
|
@ -92,8 +75,7 @@ options:
|
|||
- If C(yes), removes all "leaf" packages from the system that were originally
|
||||
installed as dependencies of user-installed packages but which are no longer
|
||||
required by any such package. Should be used alone or when state is I(absent)
|
||||
required: false
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
version_added: "2.4"
|
||||
notes:
|
||||
- When used with a `loop:` each package will be processed individually, it is much more efficient to pass the list directly to the `name` option.
|
||||
|
|
|
@ -35,41 +35,33 @@ options:
|
|||
name:
|
||||
description:
|
||||
- list of names of packages to install/remove
|
||||
required: false
|
||||
default: None
|
||||
aliases: ['pkg', 'package', 'formula']
|
||||
path:
|
||||
description:
|
||||
- "A ':' separated list of paths to search for 'brew' executable.
|
||||
Since a package (I(formula) in homebrew parlance) location is prefixed relative to the actual path of I(brew) command,
|
||||
providing an alternative I(brew) path enables managing different set of packages in an alternative location in the system."
|
||||
required: false
|
||||
default: '/usr/local/bin'
|
||||
state:
|
||||
description:
|
||||
- state of the package
|
||||
choices: [ 'head', 'latest', 'present', 'absent', 'linked', 'unlinked' ]
|
||||
required: false
|
||||
default: present
|
||||
update_homebrew:
|
||||
description:
|
||||
- update homebrew itself first
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
aliases: ['update-brew']
|
||||
upgrade_all:
|
||||
description:
|
||||
- upgrade all homebrew packages
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
aliases: ['upgrade']
|
||||
install_options:
|
||||
description:
|
||||
- options flags to install a package
|
||||
required: false
|
||||
default: null
|
||||
aliases: ['options']
|
||||
version_added: "1.4"
|
||||
notes:
|
||||
|
|
|
@ -37,47 +37,42 @@ options:
|
|||
path:
|
||||
description:
|
||||
- "':' separated list of paths to search for 'brew' executable."
|
||||
required: false
|
||||
default: '/usr/local/bin'
|
||||
state:
|
||||
description:
|
||||
- state of the cask
|
||||
choices: [ 'present', 'absent', 'upgraded' ]
|
||||
required: false
|
||||
default: present
|
||||
update_homebrew:
|
||||
description:
|
||||
- update homebrew itself first. Note that C(brew cask update) is
|
||||
a synonym for C(brew update).
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
aliases: ['update-brew']
|
||||
version_added: "2.2"
|
||||
install_options:
|
||||
description:
|
||||
- options flags to install a package
|
||||
required: false
|
||||
default: null
|
||||
aliases: ['options']
|
||||
version_added: "2.2"
|
||||
accept_external_apps:
|
||||
description:
|
||||
- allow external apps
|
||||
required: false
|
||||
default: False
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.5.0"
|
||||
upgrade_all:
|
||||
description:
|
||||
- upgrade all casks (mutually exclusive with `upgrade`)
|
||||
required: False
|
||||
default: False
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.5.0"
|
||||
upgrade:
|
||||
description:
|
||||
- upgrade all casks (mutually exclusive with `upgrade_all`)
|
||||
required: False
|
||||
default: False
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.5.0"
|
||||
'''
|
||||
EXAMPLES = '''
|
||||
|
|
|
@ -37,11 +37,9 @@ options:
|
|||
- An URL of the alternative overlays list that defines the overlay to install.
|
||||
This list will be fetched and saved under C(${overlay_defs})/${name}.xml), where
|
||||
C(overlay_defs) is readed from the Layman's configuration.
|
||||
required: false
|
||||
state:
|
||||
description:
|
||||
- Whether to install (C(present)), sync (C(updated)), or uninstall (C(absent)) the overlay.
|
||||
required: false
|
||||
default: present
|
||||
choices: [present, absent, updated]
|
||||
validate_certs:
|
||||
|
@ -49,9 +47,8 @@ options:
|
|||
- If C(no), 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
|
||||
defaulted to C(no).
|
||||
required: false
|
||||
type: bool
|
||||
default: 'yes'
|
||||
choices: ['yes', 'no']
|
||||
version_added: '1.9.3'
|
||||
'''
|
||||
|
||||
|
|
|
@ -33,34 +33,25 @@ options:
|
|||
state:
|
||||
description:
|
||||
- Whether to ensure that a publisher is present or absent.
|
||||
required: false
|
||||
default: present
|
||||
choices: [ present, absent ]
|
||||
sticky:
|
||||
description:
|
||||
- Packages installed from a sticky repository can only receive updates
|
||||
from that repository.
|
||||
required: false
|
||||
default: null
|
||||
choices: [ true, false ]
|
||||
type: bool
|
||||
enabled:
|
||||
description:
|
||||
- Is the repository enabled or disabled?
|
||||
required: false
|
||||
default: null
|
||||
choices: [ true, false ]
|
||||
type: bool
|
||||
origin:
|
||||
description:
|
||||
- A path or URL to the repository.
|
||||
- Multiple values may be provided.
|
||||
required: false
|
||||
default: null
|
||||
mirror:
|
||||
description:
|
||||
- A path or URL to the repository mirror.
|
||||
- Multiple values may be provided.
|
||||
required: false
|
||||
default: null
|
||||
'''
|
||||
EXAMPLES = '''
|
||||
# Fetch packages for the solaris publisher direct from Oracle:
|
||||
|
|
|
@ -41,48 +41,40 @@ options:
|
|||
description:
|
||||
- Name of package to install/remove;
|
||||
- multiple names may be given, separated by commas
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Intended state of the package
|
||||
choices: [ 'present', 'absent' ]
|
||||
required: false
|
||||
default: present
|
||||
update_cache:
|
||||
description:
|
||||
- Update repository database. Can be run with other steps or on it's own.
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.1"
|
||||
upgrade:
|
||||
description:
|
||||
- Upgrade main packages to their newer versions
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.1"
|
||||
full_upgrade:
|
||||
description:
|
||||
- Upgrade all packages to their newer versions
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.1"
|
||||
clean:
|
||||
description:
|
||||
- Clean packages cache
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.1"
|
||||
force:
|
||||
description:
|
||||
- Force package reinstall
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.1"
|
||||
'''
|
||||
|
||||
|
|
|
@ -30,127 +30,108 @@ options:
|
|||
package:
|
||||
description:
|
||||
- Package atom or set, e.g. C(sys-apps/foo) or C(>foo-2.13) or C(@world)
|
||||
required: false
|
||||
default: null
|
||||
|
||||
state:
|
||||
description:
|
||||
- State of the package atom
|
||||
required: false
|
||||
default: "present"
|
||||
choices: [ "present", "installed", "emerged", "absent", "removed", "unmerged", "latest" ]
|
||||
|
||||
update:
|
||||
description:
|
||||
- Update packages to the best version available (--update)
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
deep:
|
||||
description:
|
||||
- Consider the entire dependency tree of packages (--deep)
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
newuse:
|
||||
description:
|
||||
- Include installed packages where USE flags have changed (--newuse)
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
changed_use:
|
||||
description:
|
||||
- Include installed packages where USE flags have changed, except when
|
||||
- flags that the user has not enabled are added or removed
|
||||
- (--changed-use)
|
||||
required: false
|
||||
default: no
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: 1.8
|
||||
|
||||
oneshot:
|
||||
description:
|
||||
- Do not add the packages to the world file (--oneshot)
|
||||
required: false
|
||||
default: False
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
noreplace:
|
||||
description:
|
||||
- Do not re-emerge installed packages (--noreplace)
|
||||
required: false
|
||||
default: False
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
nodeps:
|
||||
description:
|
||||
- Only merge packages but not their dependencies (--nodeps)
|
||||
required: false
|
||||
default: False
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
onlydeps:
|
||||
description:
|
||||
- Only merge packages' dependencies but not the packages (--onlydeps)
|
||||
required: false
|
||||
default: False
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
depclean:
|
||||
description:
|
||||
- Remove packages not needed by explicitly merged packages (--depclean)
|
||||
- If no package is specified, clean up the world's dependencies
|
||||
- Otherwise, --depclean serves as a dependency aware version of --unmerge
|
||||
required: false
|
||||
default: False
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
quiet:
|
||||
description:
|
||||
- Run emerge in quiet mode (--quiet)
|
||||
required: false
|
||||
default: False
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
verbose:
|
||||
description:
|
||||
- Run emerge in verbose mode (--verbose)
|
||||
required: false
|
||||
default: False
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
sync:
|
||||
description:
|
||||
- Sync package repositories first
|
||||
- If yes, perform "emerge --sync"
|
||||
- If web, perform "emerge-webrsync"
|
||||
required: false
|
||||
default: null
|
||||
choices: [ "web", "yes", "no" ]
|
||||
|
||||
getbinpkg:
|
||||
description:
|
||||
- Prefer packages specified at PORTAGE_BINHOST in make.conf
|
||||
required: false
|
||||
default: False
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
usepkgonly:
|
||||
description:
|
||||
- Merge only binaries (no compiling). This sets getbinpkg=yes.
|
||||
required: false
|
||||
default: False
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
keepgoing:
|
||||
description:
|
||||
- Continue as much as possible after an error.
|
||||
required: false
|
||||
default: False
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: 2.3
|
||||
|
||||
jobs:
|
||||
|
@ -158,8 +139,6 @@ options:
|
|||
- Specifies the number of packages to build simultaneously.
|
||||
- "Since version 2.6: Value of 0 or False resets any previously added"
|
||||
- --jobs setting values
|
||||
required: false
|
||||
default: None
|
||||
version_added: 2.3
|
||||
|
||||
loadavg:
|
||||
|
@ -168,17 +147,14 @@ options:
|
|||
- other builds running and the load average is at least LOAD
|
||||
- "Since version 2.6: Value of 0 or False resets any previously added"
|
||||
- --load-average setting values
|
||||
required: false
|
||||
default: None
|
||||
version_added: 2.3
|
||||
|
||||
quietbuild:
|
||||
description:
|
||||
- Redirect all build output to logs alone, and do not display it
|
||||
- on stdout (--quiet-build)
|
||||
required: false
|
||||
default: False
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: 2.6
|
||||
|
||||
quietfail:
|
||||
|
@ -186,9 +162,8 @@ options:
|
|||
- Suppresses display of the build log on stdout (--quiet-fail)
|
||||
- Only the die message and the path of the build log will be
|
||||
- displayed on stdout.
|
||||
required: false
|
||||
default: False
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: 2.6
|
||||
|
||||
requirements: [ gentoolkit ]
|
||||
|
@ -196,7 +171,6 @@ author:
|
|||
- "William L Thomson Jr (@wltjr)"
|
||||
- "Yap Sok Ann (@sayap)"
|
||||
- "Andrew Udvare"
|
||||
notes: []
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
|
@ -26,13 +26,11 @@ options:
|
|||
add_export_distributor:
|
||||
description:
|
||||
- Whether or not to add the export distributor to new C(rpm) repositories.
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
feed:
|
||||
description:
|
||||
- Upstream feed URL to receive updates from.
|
||||
required: false
|
||||
default: null
|
||||
force_basic_auth:
|
||||
description:
|
||||
- httplib2, the library used by the M(uri) module only sends
|
||||
|
@ -40,15 +38,12 @@ options:
|
|||
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 upon initial request.
|
||||
required: false
|
||||
choices: [ "yes", "no" ]
|
||||
default: "no"
|
||||
type: bool
|
||||
default: 'no'
|
||||
importer_ssl_ca_cert:
|
||||
description:
|
||||
- CA certificate string used to validate the feed source SSL certificate.
|
||||
This can be the file content or the path to the file.
|
||||
required: false
|
||||
default: null
|
||||
importer_ssl_client_cert:
|
||||
description:
|
||||
- Certificate used as the client certificate when synchronizing the
|
||||
|
@ -57,15 +52,11 @@ options:
|
|||
certificate. The specified file may be the certificate itself or a
|
||||
single file containing both the certificate and private key. This can be
|
||||
the file content or the path to the file.
|
||||
required: false
|
||||
default: null
|
||||
importer_ssl_client_key:
|
||||
description:
|
||||
- Private key to the certificate specified in I(importer_ssl_client_cert),
|
||||
assuming it is not included in the certificate file itself. This can be
|
||||
the file content or the path to the file.
|
||||
required: false
|
||||
default: null
|
||||
name:
|
||||
description:
|
||||
- Name of the repo to add or remove. This correlates to repo-id in Pulp.
|
||||
|
@ -74,18 +65,13 @@ options:
|
|||
description:
|
||||
- Proxy url setting for the pulp repository importer. This is in the
|
||||
format scheme://host.
|
||||
required: false
|
||||
default: null
|
||||
proxy_port:
|
||||
description:
|
||||
- Proxy port setting for the pulp repository importer.
|
||||
required: false
|
||||
default: null
|
||||
publish_distributor:
|
||||
description:
|
||||
- Distributor to use when state is C(publish). The default is to
|
||||
publish all distributors.
|
||||
required: false
|
||||
pulp_host:
|
||||
description:
|
||||
- URL of the pulp server to connect to.
|
||||
|
@ -94,7 +80,6 @@ options:
|
|||
description:
|
||||
- Relative URL for the local repository.
|
||||
required: true
|
||||
default: null
|
||||
repo_type:
|
||||
description:
|
||||
- Repo plugin type to use (i.e. C(rpm), C(docker)).
|
||||
|
@ -102,19 +87,18 @@ options:
|
|||
serve_http:
|
||||
description:
|
||||
- Make the repo available over HTTP.
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
serve_https:
|
||||
description:
|
||||
- Make the repo available over HTTPS.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
state:
|
||||
description:
|
||||
- The repo state. A state of C(sync) will queue a sync of the repo.
|
||||
This is asynchronous but not delayed like a scheduled sync. A state of
|
||||
C(publish) will use the repository's distributor to publish the content.
|
||||
required: false
|
||||
default: present
|
||||
choices: [ "present", "absent", "sync", "publish" ]
|
||||
url_password:
|
||||
|
@ -122,24 +106,20 @@ options:
|
|||
- The password for use in HTTP basic authentication to the pulp API.
|
||||
If the I(url_username) parameter is not specified, the I(url_password)
|
||||
parameter will not be used.
|
||||
required: false
|
||||
url_username:
|
||||
description:
|
||||
- The username for use in HTTP basic authentication to the pulp API.
|
||||
required: false
|
||||
validate_certs:
|
||||
description:
|
||||
- If C(no), SSL certificates will not be validated. This should only be
|
||||
used on personally controlled sites using self-signed certificates.
|
||||
required: false
|
||||
type: bool
|
||||
default: 'yes'
|
||||
choices: [ "yes", "no" ]
|
||||
wait_for_completion:
|
||||
description:
|
||||
- Wait for asynchronous tasks to complete before returning.
|
||||
required: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
choices: [ "yes", "no" ]
|
||||
notes:
|
||||
- This module can currently only create distributors and importers on rpm
|
||||
repositories. Contributions to support other repo types are welcome.
|
||||
|
|
|
@ -33,83 +33,63 @@ options:
|
|||
state:
|
||||
description:
|
||||
- whether to register and subscribe (C(present)), or unregister (C(absent)) a system
|
||||
required: false
|
||||
choices: [ "present", "absent" ]
|
||||
default: "present"
|
||||
username:
|
||||
description:
|
||||
- access.redhat.com or Sat6 username
|
||||
required: False
|
||||
default: null
|
||||
password:
|
||||
description:
|
||||
- access.redhat.com or Sat6 password
|
||||
required: False
|
||||
default: null
|
||||
server_hostname:
|
||||
description:
|
||||
- Specify an alternative Red Hat Subscription Management or Sat6 server
|
||||
required: False
|
||||
server_insecure:
|
||||
description:
|
||||
- Enable or disable https server certificate verification when connecting to C(server_hostname)
|
||||
required: False
|
||||
rhsm_baseurl:
|
||||
description:
|
||||
- Specify CDN baseurl
|
||||
required: False
|
||||
server_proxy_hostname:
|
||||
description:
|
||||
- Specify a HTTP proxy hostname
|
||||
required: False
|
||||
version_added: "2.4"
|
||||
server_proxy_port:
|
||||
description:
|
||||
- Specify a HTTP proxy port
|
||||
required: False
|
||||
version_added: "2.4"
|
||||
server_proxy_user:
|
||||
description:
|
||||
- Specify a user for HTTP proxy with basic authentication
|
||||
required: False
|
||||
version_added: "2.4"
|
||||
server_proxy_password:
|
||||
description:
|
||||
- Specify a password for HTTP proxy with basic authentication
|
||||
required: False
|
||||
version_added: "2.4"
|
||||
auto_attach:
|
||||
description:
|
||||
- Upon successful registration, auto-consume available subscriptions
|
||||
- Added in favor of depracated autosubscribe in 2.5.
|
||||
required: False
|
||||
default: False
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.5"
|
||||
aliases: [autosubscribe]
|
||||
activationkey:
|
||||
description:
|
||||
- supply an activation key for use with registration
|
||||
required: False
|
||||
default: null
|
||||
org_id:
|
||||
description:
|
||||
- Organization ID to use in conjunction with activationkey
|
||||
required: False
|
||||
default: null
|
||||
version_added: "2.0"
|
||||
environment:
|
||||
description:
|
||||
- Register with a specific environment in the destination org. Used with Red Hat Satellite 6.x or Katello
|
||||
required: False
|
||||
default: null
|
||||
version_added: "2.2"
|
||||
pool:
|
||||
description:
|
||||
- |
|
||||
Specify a subscription pool name to consume. Regular expressions accepted. Use I(pool_ids) instead if
|
||||
possible, as it is much faster. Mutually exclusive with I(pool_ids).
|
||||
required: False
|
||||
default: '^$'
|
||||
pool_ids:
|
||||
description:
|
||||
|
@ -124,14 +104,10 @@ options:
|
|||
consumer_type:
|
||||
description:
|
||||
- The type of unit to register, defaults to system
|
||||
required: False
|
||||
default: null
|
||||
version_added: "2.1"
|
||||
consumer_name:
|
||||
description:
|
||||
- Name of the system to register, defaults to the hostname
|
||||
required: False
|
||||
default: null
|
||||
version_added: "2.1"
|
||||
consumer_id:
|
||||
description:
|
||||
|
@ -140,14 +116,12 @@ options:
|
|||
for this system. If the system's identity certificate is lost or corrupted,
|
||||
this option allows it to resume using its previous identity and subscriptions.
|
||||
The default is to not specify a consumer ID so a new ID is created.
|
||||
required: False
|
||||
default: null
|
||||
version_added: "2.1"
|
||||
force_register:
|
||||
description:
|
||||
- Register the system even if it is already registered
|
||||
required: False
|
||||
default: False
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.2"
|
||||
'''
|
||||
|
||||
|
|
|
@ -30,62 +30,47 @@ options:
|
|||
state:
|
||||
description:
|
||||
- whether to register (C(present)), or unregister (C(absent)) a system
|
||||
required: false
|
||||
choices: [ "present", "absent" ]
|
||||
default: "present"
|
||||
username:
|
||||
description:
|
||||
- Red Hat Network username
|
||||
required: False
|
||||
default: null
|
||||
password:
|
||||
description:
|
||||
- Red Hat Network password
|
||||
required: False
|
||||
default: null
|
||||
server_url:
|
||||
description:
|
||||
- Specify an alternative Red Hat Network server URL
|
||||
required: False
|
||||
default: Current value of I(serverURL) from C(/etc/sysconfig/rhn/up2date) is the default
|
||||
activationkey:
|
||||
description:
|
||||
- supply an activation key for use with registration
|
||||
required: False
|
||||
default: null
|
||||
profilename:
|
||||
description:
|
||||
- supply an profilename for use with registration
|
||||
required: False
|
||||
default: null
|
||||
version_added: "2.0"
|
||||
sslcacert:
|
||||
description:
|
||||
- supply a custom ssl CA certificate file for use with registration
|
||||
required: False
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
systemorgid:
|
||||
description:
|
||||
- supply an organizational id for use with registration
|
||||
required: False
|
||||
default: None
|
||||
version_added: "2.1"
|
||||
channels:
|
||||
description:
|
||||
- Optionally specify a list of comma-separated channels to subscribe to upon successful registration.
|
||||
required: false
|
||||
default: []
|
||||
enable_eus:
|
||||
description:
|
||||
- If true, extended update support will be requested.
|
||||
required: false
|
||||
default: false
|
||||
- If C(no), extended update support will be requested.
|
||||
type: bool
|
||||
default: 'no'
|
||||
nopackages:
|
||||
description:
|
||||
- If true, the registered node will not upload its installed packages information to Satellite server
|
||||
required: false
|
||||
default: false
|
||||
- If C(yes), the registered node will not upload its installed packages information to Satellite server
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.5"
|
||||
'''
|
||||
|
||||
|
|
|
@ -36,9 +36,7 @@ options:
|
|||
- multiple names can be given, separated by commas
|
||||
- special value '*' in conjunction with states C(latest) or
|
||||
C(rebuild) will update or rebuild the whole system respectively
|
||||
required: false
|
||||
aliases: ["spell"]
|
||||
default: null
|
||||
|
||||
state:
|
||||
description:
|
||||
|
@ -47,7 +45,6 @@ options:
|
|||
- state C(latest) always triggers C(update_cache=yes)
|
||||
- state C(rebuild) implies cast of all specified spells, not only
|
||||
those existed before
|
||||
required: false
|
||||
choices: ["present", "latest", "absent", "cast", "dispelled", "rebuild"]
|
||||
default: "present"
|
||||
|
||||
|
@ -60,31 +57,25 @@ options:
|
|||
contains more than one spell
|
||||
- providers must be supplied in the form recognized by Sorcery, e.g.
|
||||
'openssl(SSL)'
|
||||
required: false
|
||||
default: null
|
||||
|
||||
update:
|
||||
description:
|
||||
- Whether or not to update sorcery scripts at the very first stage
|
||||
required: false
|
||||
choices: ["yes", "no"]
|
||||
default: "no"
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
update_cache:
|
||||
description:
|
||||
- Whether or not to update grimoire collection before casting spells
|
||||
required: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
aliases: ["update_codex"]
|
||||
choices: ["yes", "no"]
|
||||
default: "no"
|
||||
|
||||
cache_valid_time:
|
||||
description:
|
||||
- Time in seconds to invalidate grimoire collection on update
|
||||
- especially useful for SCM and rsync grimoires
|
||||
- makes sense only in pair with C(update_cache)
|
||||
required: false
|
||||
default: null
|
||||
'''
|
||||
|
||||
|
||||
|
|
|
@ -30,25 +30,16 @@ options:
|
|||
description:
|
||||
- package name.
|
||||
required: true
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
version_added: 1.4
|
||||
state:
|
||||
description:
|
||||
- whether to install (C(present), C(latest)), or remove (C(absent)) a package.
|
||||
required: true
|
||||
default: null
|
||||
choices: [ 'present', 'latest', 'absent']
|
||||
aliases: []
|
||||
version_added: 1.4
|
||||
depot:
|
||||
description:
|
||||
- The source repository from which install or upgrade a package.
|
||||
required: false
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
version_added: 1.4
|
||||
'''
|
||||
|
||||
|
|
|
@ -27,55 +27,38 @@ options:
|
|||
description:
|
||||
- URL pointing to the contents of available bundles.
|
||||
If not specified, the contents are retrieved from clearlinux.org.
|
||||
required: false
|
||||
default: null
|
||||
format:
|
||||
description:
|
||||
- The format suffix for version file downloads. For example [1,2,3,staging,etc].
|
||||
If not specified, the default format is used.
|
||||
required: false
|
||||
default: null
|
||||
manifest:
|
||||
description:
|
||||
- The manifest contains information about the bundles at certaion version of the OS.
|
||||
Specify a Manifest version to verify against that version or leave unspecified to
|
||||
verify against the current version.
|
||||
required: false
|
||||
default: null
|
||||
aliases: [release, version]
|
||||
name:
|
||||
description:
|
||||
- Name of the (I)bundle to install or remove.
|
||||
required: false
|
||||
default: null
|
||||
aliases: [bundle]
|
||||
state:
|
||||
description:
|
||||
- Indicates the desired (I)bundle state. C(present) ensures the bundle
|
||||
is installed while C(absent) ensures the (I)bundle is not installed.
|
||||
required: false
|
||||
default: present
|
||||
choices: [present, absent]
|
||||
update:
|
||||
description:
|
||||
- Updates the OS to the latest version.
|
||||
required: false
|
||||
default: no
|
||||
url:
|
||||
description:
|
||||
- Overrides both I(contenturl) and I(versionurl).
|
||||
required: false
|
||||
default: null
|
||||
verify:
|
||||
description:
|
||||
- Verify content for OS version.
|
||||
required: false
|
||||
default: null
|
||||
versionurl:
|
||||
description:
|
||||
- URL for version string download.
|
||||
required: false
|
||||
default: null
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
|
@ -28,12 +28,9 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Name of the package to install, upgrade, or remove.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Desired state of the package.
|
||||
required: false
|
||||
default: "present"
|
||||
choices: ["present", "absent", "latest"]
|
||||
recurse:
|
||||
|
@ -41,22 +38,19 @@ options:
|
|||
- When removing a package, also remove its dependencies, provided
|
||||
that they are not required by other packages and were not
|
||||
explicitly installed by a user.
|
||||
required: false
|
||||
default: no
|
||||
choices: ["yes", "no"]
|
||||
type: bool
|
||||
default: 'no'
|
||||
update_cache:
|
||||
description:
|
||||
- Whether or not to refresh the master package lists. This can be
|
||||
run as part of a package installation or as a separate step.
|
||||
required: false
|
||||
default: yes
|
||||
choices: ["yes", "no"]
|
||||
type: bool
|
||||
default: 'yes'
|
||||
upgrade:
|
||||
description:
|
||||
- Whether or not to upgrade whole system
|
||||
required: false
|
||||
default: no
|
||||
choices: ["yes", "no"]
|
||||
type: bool
|
||||
default: 'no'
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
|
@ -26,15 +26,12 @@ description:
|
|||
|
||||
options:
|
||||
async:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
default: 'yes'
|
||||
description:
|
||||
- If set to C(yes) Yum will download packages and metadata from this
|
||||
repo in parallel, if possible.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
bandwidth:
|
||||
required: false
|
||||
default: 0
|
||||
description:
|
||||
- Maximum available network bandwidth in bytes/second. Used with the
|
||||
I(throttle) option.
|
||||
|
@ -42,9 +39,8 @@ options:
|
|||
throttling will be disabled. If I(throttle) is expressed as a data rate
|
||||
(bytes/sec) then this option is ignored. Default is C(0) (no bandwidth
|
||||
throttling).
|
||||
default: 0
|
||||
baseurl:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- URL to the directory where the yum repository's 'repodata' directory
|
||||
lives.
|
||||
|
@ -52,56 +48,46 @@ options:
|
|||
- This, the I(metalink) or I(mirrorlist) parameters are required if I(state) is set to
|
||||
C(present).
|
||||
cost:
|
||||
required: false
|
||||
default: 1000
|
||||
description:
|
||||
- Relative cost of accessing this repository. Useful for weighing one
|
||||
repo's packages as greater/less than any other.
|
||||
default: 1000
|
||||
deltarpm_metadata_percentage:
|
||||
required: false
|
||||
default: 100
|
||||
description:
|
||||
- When the relative size of deltarpm metadata vs pkgs is larger than
|
||||
this, deltarpm metadata is not downloaded from the repo. Note that you
|
||||
can give values over C(100), so C(200) means that the metadata is
|
||||
required to be half the size of the packages. Use C(0) to turn off
|
||||
this check, and always download metadata.
|
||||
default: 100
|
||||
deltarpm_percentage:
|
||||
required: false
|
||||
default: 75
|
||||
description:
|
||||
- When the relative size of delta vs pkg is larger than this, delta is
|
||||
not used. Use C(0) to turn off delta rpm processing. Local repositories
|
||||
(with file:// I(baseurl)) have delta rpms turned off by default.
|
||||
default: 75
|
||||
description:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- A human readable string describing the repository.
|
||||
- This parameter is only required if I(state) is set to C(present).
|
||||
enabled:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
default: 'yes'
|
||||
description:
|
||||
- This tells yum whether or not use this repository.
|
||||
enablegroups:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
default: 'yes'
|
||||
enablegroups:
|
||||
description:
|
||||
- Determines whether yum will allow the use of package groups for this
|
||||
repository.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
exclude:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- List of packages to exclude from updates or installs. This should be a
|
||||
space separated list. Shell globs using wildcards (eg. C(*) and C(?))
|
||||
are allowed.
|
||||
- The list can also be a regular YAML array.
|
||||
failovermethod:
|
||||
required: false
|
||||
choices: [roundrobin, priority]
|
||||
default: roundrobin
|
||||
description:
|
||||
|
@ -111,33 +97,22 @@ options:
|
|||
- C(priority) starts from the first I(baseurl) listed and reads through
|
||||
them sequentially.
|
||||
file:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- File name without the C(.repo) extension to save the repo in. Defaults
|
||||
to the value of I(name).
|
||||
gpgcakey:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- A URL pointing to the ASCII-armored CA key file for the repository.
|
||||
gpgcheck:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
default: null
|
||||
description:
|
||||
- Tells yum whether or not it should perform a GPG signature check on
|
||||
packages.
|
||||
type: bool
|
||||
gpgkey:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- A URL pointing to the ASCII-armored GPG key file for the repository.
|
||||
- It can also be a list of multiple URLs.
|
||||
http_caching:
|
||||
required: false
|
||||
choices: [all, packages, none]
|
||||
default: all
|
||||
description:
|
||||
- Determines how upstream HTTP caches are instructed to handle any HTTP
|
||||
downloads that Yum does.
|
||||
|
@ -145,17 +120,15 @@ options:
|
|||
- C(packages) means that only RPM package downloads should be cached (but
|
||||
not repository metadata downloads).
|
||||
- C(none) means that no HTTP downloads should be cached.
|
||||
choices: [all, packages, none]
|
||||
default: all
|
||||
include:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Include external configuration file. Both, local path and URL is
|
||||
supported. Configuration file will be inserted at the position of the
|
||||
I(include=) line. Included files may contain further include lines.
|
||||
Yum will abort with an error if an inclusion loop is detected.
|
||||
includepkgs:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- List of packages you want to only use from a repository. This should be
|
||||
a space separated list. Shell globs using wildcards (eg. C(*) and C(?))
|
||||
|
@ -163,38 +136,31 @@ options:
|
|||
here.
|
||||
- The list can also be a regular YAML array.
|
||||
ip_resolve:
|
||||
required: false
|
||||
choices: [4, 6, IPv4, IPv6, whatever]
|
||||
default: whatever
|
||||
description:
|
||||
- Determines how yum resolves host names.
|
||||
- C(4) or C(IPv4) - resolve to IPv4 addresses only.
|
||||
- C(6) or C(IPv6) - resolve to IPv6 addresses only.
|
||||
choices: [4, 6, IPv4, IPv6, whatever]
|
||||
default: whatever
|
||||
keepalive:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
default: 'no'
|
||||
description:
|
||||
- This tells yum whether or not HTTP/1.1 keepalive should be used with
|
||||
this repository. This can improve transfer speeds by using one
|
||||
connection when downloading multiple files from a repository.
|
||||
type: bool
|
||||
default: 'no'
|
||||
keepcache:
|
||||
required: false
|
||||
choices: ['0', '1']
|
||||
default: '1'
|
||||
description:
|
||||
- Either C(1) or C(0). Determines whether or not yum keeps the cache of
|
||||
headers and packages after successful installation.
|
||||
choices: ['0', '1']
|
||||
default: '1'
|
||||
metadata_expire:
|
||||
required: false
|
||||
default: 21600
|
||||
description:
|
||||
- Time (in seconds) after which the metadata will expire.
|
||||
- Default value is 6 hours.
|
||||
default: 21600
|
||||
metadata_expire_filter:
|
||||
required: false
|
||||
choices: [never, 'read-only:past', 'read-only:present', 'read-only:future']
|
||||
default: 'read-only:present'
|
||||
description:
|
||||
- Filter the I(metadata_expire) time, allowing a trade of speed for
|
||||
accuracy if a command doesn't require it. Each yum command can specify
|
||||
|
@ -212,9 +178,9 @@ options:
|
|||
other commands which will require the latest metadata. Eg.
|
||||
I(yum check-update).
|
||||
- Note that this option does not override "yum clean expire-cache".
|
||||
choices: [never, 'read-only:past', 'read-only:present', 'read-only:future']
|
||||
default: 'read-only:present'
|
||||
metalink:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Specifies a URL to a metalink file for the repomd.xml, a list of
|
||||
mirrors for the entire repository are generated by converting the
|
||||
|
@ -222,96 +188,75 @@ options:
|
|||
- This, the I(baseurl) or I(mirrorlist) parameters are required if I(state) is set to
|
||||
C(present).
|
||||
mirrorlist:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Specifies a URL to a file containing a list of baseurls.
|
||||
- This, the I(baseurl) or I(metalink) parameters are required if I(state) is set to
|
||||
C(present).
|
||||
mirrorlist_expire:
|
||||
required: false
|
||||
default: 21600
|
||||
description:
|
||||
- Time (in seconds) after which the mirrorlist locally cached will
|
||||
expire.
|
||||
- Default value is 6 hours.
|
||||
default: 21600
|
||||
name:
|
||||
required: true
|
||||
description:
|
||||
- Unique repository ID.
|
||||
- This parameter is only required if I(state) is set to C(present) or
|
||||
C(absent).
|
||||
required: true
|
||||
password:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Password to use with the username for basic authentication.
|
||||
priority:
|
||||
required: false
|
||||
default: 99
|
||||
description:
|
||||
- Enforce ordered protection of repositories. The value is an integer
|
||||
from 1 to 99.
|
||||
- This option only works if the YUM Priorities plugin is installed.
|
||||
default: 99
|
||||
protect:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
default: 'no'
|
||||
description:
|
||||
- Protect packages from updates from other repositories.
|
||||
type: bool
|
||||
default: 'no'
|
||||
proxy:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- URL to the proxy server that yum should use. Set to C(_none_) to
|
||||
disable the global proxy setting.
|
||||
proxy_password:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Username to use for proxy.
|
||||
proxy_username:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Password for this proxy.
|
||||
repo_gpgcheck:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
default: 'no'
|
||||
description:
|
||||
- This tells yum whether or not it should perform a GPG signature check
|
||||
on the repodata from this repository.
|
||||
type: bool
|
||||
default: 'no'
|
||||
reposdir:
|
||||
required: false
|
||||
default: /etc/yum.repos.d
|
||||
description:
|
||||
- Directory where the C(.repo) files will be stored.
|
||||
default: /etc/yum.repos.d
|
||||
retries:
|
||||
required: false
|
||||
default: 10
|
||||
description:
|
||||
- Set the number of times any attempt to retrieve a file should retry
|
||||
before returning an error. Setting this to C(0) makes yum try forever.
|
||||
default: 10
|
||||
s3_enabled:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
default: 'no'
|
||||
description:
|
||||
- Enables support for S3 repositories.
|
||||
- This option only works if the YUM S3 plugin is installed.
|
||||
skip_if_unavailable:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
default: 'no'
|
||||
skip_if_unavailable:
|
||||
description:
|
||||
- If set to C(yes) yum will continue running if this repository cannot be
|
||||
contacted for any reason. This should be set carefully as all repos are
|
||||
consulted for any given command.
|
||||
ssl_check_cert_permissions:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
default: 'no'
|
||||
ssl_check_cert_permissions:
|
||||
description:
|
||||
- Whether yum should check the permissions on the paths for the
|
||||
certificates on the repository (both remote and local).
|
||||
|
@ -319,58 +264,46 @@ options:
|
|||
I(skip_if_unavailable) to be C(yes). This is most useful for non-root
|
||||
processes which use yum on repos that have client cert files which are
|
||||
readable only by root.
|
||||
type: bool
|
||||
default: 'no'
|
||||
sslcacert:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Path to the directory containing the databases of the certificate
|
||||
authorities yum should use to verify SSL certificates.
|
||||
sslclientcert:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Path to the SSL client certificate yum should use to connect to
|
||||
repos/remote sites.
|
||||
sslclientkey:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Path to the SSL client key yum should use to connect to repos/remote
|
||||
sites.
|
||||
sslverify:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
default: 'yes'
|
||||
description:
|
||||
- Defines whether yum should verify SSL certificates/hosts at all.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
state:
|
||||
required: false
|
||||
choices: [absent, present]
|
||||
default: present
|
||||
description:
|
||||
- State of the repo file.
|
||||
choices: [absent, present]
|
||||
default: present
|
||||
throttle:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Enable bandwidth throttling for downloads.
|
||||
- This option can be expressed as a absolute data rate in bytes/sec. An
|
||||
SI prefix (k, M or G) may be appended to the bandwidth value.
|
||||
timeout:
|
||||
required: false
|
||||
default: 30
|
||||
description:
|
||||
- Number of seconds to wait for a connection before timing out.
|
||||
default: 30
|
||||
ui_repoid_vars:
|
||||
required: false
|
||||
default: releasever basearch
|
||||
description:
|
||||
- When a repository id is displayed, append these yum variables to the
|
||||
string if they are used in the I(baseurl)/etc. Variables are appended
|
||||
in the order listed (and found).
|
||||
default: releasever basearch
|
||||
username:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Username to use for basic authentication to a repo or really any url.
|
||||
|
||||
|
|
|
@ -25,24 +25,17 @@ description:
|
|||
- Add or remove Zypper repositories on SUSE and openSUSE
|
||||
options:
|
||||
name:
|
||||
required: false
|
||||
default: none
|
||||
description:
|
||||
- A name for the repository. Not required when adding repofiles.
|
||||
repo:
|
||||
required: false
|
||||
default: none
|
||||
description:
|
||||
- URI of the repository or .repo file. Required when state=present.
|
||||
state:
|
||||
required: false
|
||||
choices: [ "absent", "present" ]
|
||||
default: "present"
|
||||
description:
|
||||
- A source string state.
|
||||
choices: [ "absent", "present" ]
|
||||
default: "present"
|
||||
description:
|
||||
required: false
|
||||
default: none
|
||||
description:
|
||||
- A description of the repository
|
||||
disable_gpg_check:
|
||||
|
@ -51,30 +44,26 @@ options:
|
|||
all packages. Has an effect only if state is
|
||||
I(present).
|
||||
- Needs zypper version >= 1.6.2.
|
||||
required: false
|
||||
default: "no"
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
autorefresh:
|
||||
description:
|
||||
- Enable autorefresh of the repository.
|
||||
required: false
|
||||
default: "yes"
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'yes'
|
||||
aliases: [ "refresh" ]
|
||||
priority:
|
||||
description:
|
||||
- Set priority of repository. Packages will always be installed
|
||||
from the repository with the smallest priority number.
|
||||
- Needs zypper version >= 1.12.25.
|
||||
required: false
|
||||
version_added: "2.1"
|
||||
overwrite_multiple:
|
||||
description:
|
||||
- Overwrite multiple repository entries, if repositories with both name and
|
||||
URL already exist.
|
||||
required: false
|
||||
default: "no"
|
||||
choices: [ "yes", "no" ]
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.1"
|
||||
auto_import_keys:
|
||||
description:
|
||||
|
@ -82,24 +71,21 @@ options:
|
|||
- Has an effect only if state is I(present). Has no effect on existing (unchanged) repositories or in combination with I(absent).
|
||||
- Implies runrefresh.
|
||||
- Only works with C(.repo) files if `name` is given explicitly.
|
||||
required: false
|
||||
default: "no"
|
||||
choices: ["yes", "no"]
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.2"
|
||||
runrefresh:
|
||||
description:
|
||||
- Refresh the package list of the given repository.
|
||||
- Can be used with repo=* to refresh all repositories.
|
||||
required: false
|
||||
default: "no"
|
||||
choices: ["yes", "no"]
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.2"
|
||||
enabled:
|
||||
description:
|
||||
- Set repository to enabled (or disabled).
|
||||
required: false
|
||||
default: "yes"
|
||||
choices: ["yes", "no"]
|
||||
type: bool
|
||||
default: 'yes'
|
||||
version_added: "2.2"
|
||||
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue