f5networks.f5_modules.bigip_ucs_fetch – Fetches a UCS file from remote nodes

Note

This plugin is part of the f5networks.f5_modules collection (version 1.7.1).

To install it use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigip_ucs_fetch.

New in version 1.0.0: of f5networks.f5_modules

Synopsis

• This module is used for fetching UCS files from remote machines and storing them locally in a file tree, organized by hostname. This module is written to transfer UCS files that might not be present, so a missing remote UCS is not an error unless fail_on_missing is set to ‘yes’.

Parameters

Parameter		Choices/Defaults	Comments
async_timeout integer		Default: 150	Parameter used when creating new UCS file on device. The amount of time in seconds to wait for the API async interface to complete its task. The accepted value range is between 150 and 1800 seconds.
backup boolean		Choices: no ← yes	Create a backup file including the timestamp information so you can get the original file back if you somehow overwrote it incorrectly.
create_on_missing boolean		Choices: no yes ←	Creates the UCS based on the value of src, if the file does not already exist on the remote system.
dest path / required			A directory to save the UCS file into.
encryption_password string			Password to use to encrypt the UCS file if desired.
fail_on_missing boolean		Choices: no ← yes	Make the module fail if the UCS file on the remote system is missing.
force boolean		Choices: no yes ←	If no, the file will only be transferred if the destination does not exist.
provider dictionary added in 1.0.0 of f5networks.f5_modules			A dict object containing connection details.
	auth_provider string		Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices.
	no_f5_teem boolean	Choices: no yes	If yes, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable F5_TEEM.
	password string / required		The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable F5_PASSWORD. aliases: pass, pwd
	server string / required		The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER.
	server_port integer	Default: 443	The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT.
	timeout integer		Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
	transport string	Choices: rest ←	Configures the transport connection to use when connecting to the remote device.
	user string / required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable F5_USER.
	validate_certs boolean	Choices: no yes ←	If no, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable F5_VALIDATE_CERTS.
src string			The name of the UCS file to create on the remote server for downloading. The file will be retrieved or created in /var/local/ucs/.

Notes

Note

• BIG-IP provides no way to get a checksum of the UCS files on the system via any interface with the possible exception of logging in directly to the box (which would not support appliance mode). Therefore, the best this module can do is check for the existence of the file on disk; no check-summing.

• If you are using this module with either Ansible Tower or Ansible AWX, you should be aware of how these Ansible products execute jobs in restricted environments. More information can be found here https://clouddocs.f5.com/products/orchestration/ansible/devel/usage/module-usage-with-tower.html

• For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.

• Requires BIG-IP software version >= 12.

• The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.

Examples

- name: Download a new UCS
  bigip_ucs_fetch:
    src: cs_backup.ucs
    dest: /tmp/cs_backup.ucs
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
backup_file string	changed and if backup=yes	Name of backup file. Sample: /path/to/file.txt.2015-02-12@22:09~
checksum string	success or changed	The SHA1 checksum of the downloaded file. Sample: 7b46bbe4f8ebfee64761b5313855618f64c64109
dest string	success	Location on the ansible host the UCS was saved to. Sample: /path/to/file.txt
gid integer	success	Group ID of the UCS file, after execution. Sample: 100
group string	success	Group of the UCS file, after execution. Sample: httpd
md5sum string	changed or success	The MD5 checksum of the downloaded file. Sample: 96cacab4c259c4598727d7cf2ceb3b45
mode string	success	Permissions of the target UCS, after execution. Sample: 420
owner string	success	Owner of the UCS file, after execution. Sample: httpd
size integer	success	Size of the target UCS, after execution. Sample: 1220
src string	changed	Name of the UCS file on the remote BIG-IP to download. If not specified, this will be a randomly generated filename. Sample: cs_backup.ucs
uid integer	success	Owner ID of the UCS file, after execution. Sample: 100

Authors

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)