bigip_file_copy – Manage files in datastores on a BIG-IP

New in version 2.8.

Synopsis

  • Manages files on a variety of datastores on a BIG-IP.

Parameters

Parameter Choices/Defaults Comments
datastore
string
    Choices:
  • external-monitor
  • ifile ←
  • lw4o6-table
Specifies the datastore to put the file in.
There are several different datastores and each of them allows files to be exposed in different ways.
When external-monitor, the specified file will be stored as an external monitor file and be available for use in external monitors
When ifile, the specified file will be stored as an iFile.
When lw4o6-table, the specified file will be store as an Lightweight 4 over 6 (lw4o6) tunnel binding table, which include an IPv6 address for the lwB4, public IPv4 address, and restricted port set.
force
boolean
    Choices:
  • no
  • yes
Force overwrite a file.
By default, files will only be overwritten if the SHA of the file is different for the given filename. This parameter can be used to force overwrite the file even if it already exists and its SHA matches.
The lw4o6-table datastore does not keep checksums of its file. Therefore, you would need to provide this argument to update any of these files.
name
string
The name of the file as it should reside on the BIG-IP.
If this is not specified, then the filename provided in the source parameter is used instead.
partition
string
Default:
"Common"
Device partition to manage resources on.
provider
dictionary
added in 2.5
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.
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.
ssh_keyfile
path
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports.
You may omit this option by setting the environment variable ANSIBLE_NET_SSH_KEYFILE.
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:
  • cli
  • 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.
source
path
Specifies the path of the file to upload.
This parameter is required if state is present.

aliases: src
state
string
    Choices:
  • present ←
  • absent
When present, ensures that the resource exists.
When absent, ensures the resource is removed.

Notes

Note

  • 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 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: Upload a file as an iFile
  bigip_file_copy:
    name: foo
    source: /path/to/file.txt
    datastore: ifile
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

# Upload a directory of files
- name: Recursively upload web related files in /var/tmp/project
  find:
    paths: /var/tmp/project
    patterns: "^.*?\\.(?:html|?:css|?:js)$"
    use_regex: yes
  register: f

- name: Upload a directory of files as a set of iFiles
  bigip_file_copy:
    source: "{{ item.path }}"
    datastore: ifile
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
    loop: f
  delegate_to: localhost
# End upload a directory of files

- name: Upload a file to use in an external monitor
  bigip_file_copy:
    source: /path/to/files/external.sh
    datastore: external-monitor
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Status

Authors

  • Tim Rupp (@caphrim007)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.