yum_repository
Collection: builtin
Full Name: parallax.builtin.yum_repository
Aliases: ansible.builtin.yum_repository, yum_repository
Synopsis
Manage yum repository
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| name | string | yes | Unique repository ID | |
| state | string | present | State of the repo Choices: absent, present | |
| async | bool | true | If set to yes Yum will download packages and metadata from this repo in parallel | |
| bandwidth | string | Maximum available network bandwidth in bytes/second | ||
| baseurl | list | URL to the directory where the yum repository’s ‘repodata’ directory lives | ||
| cost | string | Relative cost of accessing this repository | ||
| deltarpm_metadata_percentage | string | When the relative size of deltarpm metadata vs pkgs is larger than this, deltarpm metadata is not downloaded | ||
| deltarpm_percentage | string | When the relative size of delta vs pkg is larger than this, delta is not used | ||
| description | string | A human readable string describing the repository | ||
| enabled | bool | true | This tells yum whether or not use this repository | |
| enablegroups | bool | true | Determines whether yum will allow the use of package groups for this repository | |
| exclude | list | List of packages to exclude from updates or installs | ||
| failovermethod | string | roundrobin | Either ‘roundrobin’ or ‘priority’ Choices: priority, roundrobin | |
| file | string | File name without the .repo extension to save the repo in | ||
| gpgcakey | string | A URL pointing to the ASCII-armored CA key file for the repository | ||
| gpgcheck | bool | false | Tells yum whether or not it should perform a GPG signature check on packages | |
| gpgkey | list | A URL pointing to the ASCII-armored GPG key file for the repository | ||
| http_caching | string | all | Determines how upstream HTTP caches are instructed to handle any HTTP downloads Choices: all, packages, none | |
| include | list | Include external configuration file | ||
| includepkgs | list | List of packages you want to only use from a repository | ||
| ip_resolve | string | whatever | Determines how yum resolves host names Choices: 4, 6, IPv4, IPv6, whatever | |
| keepalive | bool | false | This tells yum whether or not HTTP/1.1 keepalive should be used with this repository | |
| keepcache | string | 1 | Either ‘1’ or ‘0’ Choices: 0, 1 | |
| metadata_expire | string | 21600 | Time (in seconds) after which the metadata will expire | |
| metadata_expire_filter | string | read-only:present | Filter the metadata_expire time Choices: never, read-only:past, read-only:present, read-only:future | |
| metalink | string | Specifies a URL to a metalink file for the repomd.xml | ||
| mirrorlist | string | Specifies a URL to a file containing a list of baseurls | ||
| mirrorlist_expire | string | Time (in seconds) after which the mirrorlist locally cached will expire | ||
| password | string | Password to use with the username for basic authentication | ||
| priority | string | 99 | Enforce ordered protection of repositories | |
| protect | bool | false | Protect packages from updates from other repositories | |
| proxy | string | URL to the proxy server that yum should use | ||
| proxy_password | string | Password for this proxy | ||
| proxy_username | string | Username to use for proxy | ||
| repo_gpgcheck | bool | false | This tells yum whether or not it should perform a GPG signature check on the repodata | |
| repofile | string | File to write the repository configuration to | ||
| retries | string | 10 | Set the number of times any attempt to retrieve a file should retry before returning an error | |
| s3_enabled | bool | false | Enables support for S3 repositories | |
| skip_if_unavailable | bool | false | If set to yes yum will continue running if this repository cannot be contacted | |
| ssl_check_cert_permissions | bool | false | Whether yum should check the permissions on the paths for the certificates | |
| sslcacert | string | Path to the directory containing the databases of the certificate authorities | ||
| sslclientcert | string | Path to the SSL client certificate yum should use to connect to repos/remote sites | ||
| sslclientkey | string | Path to the SSL client key yum should use to connect to repos/remote sites | ||
| sslverify | bool | true | Defines whether yum should verify SSL certificates/signatures | |
| throttle | string | Enable bandwidth throttling for downloads | ||
| timeout | string | 30 | Number of seconds to wait for a connection before timing out | |
| ui_repoid_vars | string | When a repository id is displayed, append these yum variables to the string | ||
| username | string | Username to use for basic authentication to a repo or really any url |
Example
- name: Example yum_repository task
yum_repository:
name: <your_name>