New in version 2.4.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
force bool |
| 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 bool |
| During restore of the UCS file, include chassis level configuration that is shared among boot volume sets. For example, cluster default configuration. | |
no_license bool |
| 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 bool |
| 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 bool |
| 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 may omit this option by setting the environment variable F5_PASSWORD .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. You may omit this option by setting the environment variable ANSIBLE_NET_SSH_KEYFILE . | ||
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 may omit this option by setting the environment variable F5_SERVER . | ||
user 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 . | ||
server_port | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
password 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 | ||
validate_certs bool |
| 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 . | |
transport required |
| Configures the transport connection to use when connecting to the remote device. | |
reset_trust bool |
| 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 may omit this option by setting the environment variable F5_SERVER . | ||
server_port (added in 2.2) | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
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 may omit this option by setting the environment variable F5_USER . | ||
validate_certs bool (added in 2.0) |
| 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 . |
Note
bigip_hostname
Ansible module in a task before using this module.pip install f5-sdk
.- 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
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_ucs_module.html