bigip_ucs - Manage upload, installation and removal of UCS files
New in version 2.4.
Synopsis
- Manage upload, installation and removal of UCS files.
Requirements
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.9
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| force |
| If yes will upload the file every time and replace the file on the device. If no, the file will only be uploaded if it does not already exist. Generally should be yes only in cases where you have reason to believe that the image was corrupted during upload. | |
| include_chassis_level_config |
| During restore of the UCS file, include chassis level configuration that is shared among boot volume sets. For example, cluster default configuration. | |
| no_license |
| Performs a full restore of the UCS file and all the files it contains, with the exception of the license file. The option must be used to restore a UCS on RMA devices (Returned Materials Authorization). | |
| no_platform_check |
| Bypasses the platform check and allows a UCS that was created using a different platform to be installed. By default (without this option), a UCS created from a different platform is not allowed to be installed. | |
| passphrase |
| Specifies the passphrase that is necessary to load the specified UCS file. | |
| password required | The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable F5_PASSWORD is set.aliases: pass, pwd | ||
| provider (added in 2.5) | Default: None | A dict object containing connection details. | |
| ssh_keyfile | Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead. | ||
| timeout | Default: 10 | 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. | |
| server required | The BIG-IP host. You can omit this option if the environment variable F5_SERVER is set. | ||
| user required | The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable F5_USER is set. | ||
| server_port | Default: 443 | The BIG-IP server port. You can omit this option if the environment variable F5_SERVER_PORT is set. | |
| password required | The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable F5_PASSWORD is set.aliases: pass, pwd | ||
| validate_certs |
| If no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. | |
| transport required |
| Configures the transport connection to use when connecting to the remote device. | |
| reset_trust |
| When specified, the device and trust domain certs and keys are not loaded from the UCS. Instead, a new set is regenerated. | |
| server required | The BIG-IP host. You can omit this option if the environment variable F5_SERVER is set. | ||
| server_port (added in 2.2) | Default: 443 | The BIG-IP server port. You can omit this option if the environment variable F5_SERVER_PORT is set. | |
| state |
| When installed, ensures that the UCS is uploaded and installed, on the system. When present, ensures that the UCS is uploaded. When absent, the UCS will be removed from the system. When installed, the uploading of the UCS is idempotent, however the installation of that configuration is not idempotent. | |
| ucs | The path to the UCS file to install. The parameter must be provided if the state is either installed or activated. When state is absent, the full path for this parameter will be ignored and only the filename will be used to select a UCS for removal. Therefore you could specify /mickey/mouse/test.ucs and this module would only look for test.ucs. | ||
| user required | The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable F5_USER is set. | ||
| validate_certs (added in 2.0) |
| If no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. | |
Notes
Note
- Only the most basic checks are performed by this module. Other checks and considerations need to be taken into account. See the following URL. https://support.f5.com/kb/en-us/solutions/public/11000/300/sol11318.html
- This module does not handle devices with the FIPS 140 HSM
- This module does not handle BIG-IPs systems on the 6400, 6800, 8400, or 8800 hardware platform.
- This module does not verify that the new or replaced SSH keys from the UCS file are synchronized between the BIG-IP system and the SCCP
- This module does not support the ‘rma’ option
- This module does not support restoring a UCS archive on a BIG-IP 1500, 3400, 4100, 6400, 6800, or 8400 hardware platform other than the system from which the backup was created
- The UCS restore operation restores the full configuration only if the hostname of the target system matches the hostname on which the UCS archive was created. If the hostname does not match, only the shared configuration is restored. You can ensure hostnames match by using the
bigip_hostnameAnsible module in a task before using this module. - This module does not support re-licensing a BIG-IP restored from a UCS
- This module does not support restoring encrypted archives on replacement RMA units.
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires the f5-sdk Python package on the host. This is as easy as
pip install f5-sdk.
Examples
- name: Upload UCS
bigip_ucs:
server: lb.mydomain.com
user: admin
password: secret
ucs: /root/bigip.localhost.localdomain.ucs
state: present
delegate_to: localhost
- name: Install (upload, install) UCS.
bigip_ucs:
server: lb.mydomain.com
user: admin
password: secret
ucs: /root/bigip.localhost.localdomain.ucs
state: installed
delegate_to: localhost
- name: Install (upload, install) UCS without installing the license portion
bigip_ucs:
server: lb.mydomain.com
user: admin
password: secret
ucs: /root/bigip.localhost.localdomain.ucs
state: installed
no_license: yes
delegate_to: localhost
- name: Install (upload, install) UCS except the license, and bypassing the platform check
bigip_ucs:
server: lb.mydomain.com
user: admin
password: secret
ucs: /root/bigip.localhost.localdomain.ucs
state: installed
no_license: yes
no_platform_check: yes
delegate_to: localhost
- name: Install (upload, install) UCS using a passphrase necessary to load the UCS
bigip_ucs:
server: lb.mydomain.com
user: admin
password: secret
ucs: /root/bigip.localhost.localdomain.ucs
state: installed
passphrase: MyPassphrase1234
delegate_to: localhost
- name: Remove uploaded UCS file
bigip_ucs:
server: lb.mydomain.com
user: admin
password: secret
ucs: bigip.localhost.localdomain.ucs
state: absent
delegate_to: localhost
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Tim Rupp (@caphrim007)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/bigip_ucs_module.html