W3cubDocs

/Ansible

bigip_ucs - Manage upload, installation and removal of UCS files.

New in version 2.4.

Synopsis
Requirements (on host that executes module)
Options
Examples
Notes
- Status

Synopsis

Manage upload, installation and removal of UCS files.

Requirements (on host that executes module)

f5-sdk

Options

parameter	required	default	choices	comments
force	no		True False	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	no		True False	During restore of the UCS file, include chassis level configuration that is shared among boot volume sets. For example, cluster default configuration.
no_license	no		True False	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	no		True False	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	no		True False	Specifies the passphrase that is necessary to load the specified UCS file.
password	yes			The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable `F5_PASSWORD` is set.
reset_trust	no		True False	When specified, the device and trust domain certs and keys are not loaded from the UCS. Instead, a new set is regenerated.
server	yes			The BIG-IP host. This option can be omitted if the environment variable `F5_SERVER` is set.
server_port (added in 2.2)	no	443		The BIG-IP server port. This option can be omitted if the environment variable `F5_SERVER_PORT` is set.
state	no	present	absent installed present	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	no			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	yes			The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable `F5_USER` is set.
validate_certs (added in 2.0)	no	True	True False	If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable `F5_VALIDATE_CERTS` is set.

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

Notes

Note

Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.
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_hostname Ansible 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.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/bigip_ucs_module.html