Try SpotterManage upload, installation and removal of UCS files
| "added in version" 2.4 of ansible.builtin"
Authors: Tim Rupp (@caphrim007)
preview | supported by community
pipInstall with pip install ansible==2.5.6
Manage upload, installation and removal of UCS files.
- 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
ucs:
description:
- The path to the UCS file to install. The parameter must be provided if the C(state)
is either C(installed) or C(activated). When C(state) is C(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 C(/mickey/mouse/test.ucs) and this
module would only look for C(test.ucs).
force:
choices:
- true
- false
description:
- If C(yes) will upload the file every time and replace the file on the device. If
C(no), the file will only be uploaded if it does not already exist. Generally should
be C(yes) only in cases where you have reason to believe that the image was corrupted
during upload.
state:
choices:
- absent
- installed
- present
default: present
description:
- When C(installed), ensures that the UCS is uploaded and installed, on the system.
When C(present), ensures that the UCS is uploaded. When C(absent), the UCS will
be removed from the system. When C(installed), the uploading of the UCS is idempotent,
however the installation of that configuration is not idempotent.
provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- The password for the user account used to connect to the BIG-IP or the BIG-IQ.
- You may omit this option by setting the environment variable C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- 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.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative
privileges on the device.
- You may omit this option by setting the environment variable C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(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 C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules
no_license:
choices:
- true
- false
description:
- 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).
passphrase:
choices:
- true
- false
description:
- Specifies the passphrase that is necessary to load the specified UCS file.
reset_trust:
choices:
- true
- false
description:
- When specified, the device and trust domain certs and keys are not loaded from the
UCS. Instead, a new set is regenerated.
no_platform_check:
choices:
- true
- false
description:
- 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.
include_chassis_level_config:
choices:
- true
- false
description:
- During restore of the UCS file, include chassis level configuration that is shared
among boot volume sets. For example, cluster default configuration.