f5os_system_image_install – Manage F5OS system software installation.¶
New in version 1.11.0.
Parameters¶
| Parameter | Choices/Defaults | Configuration | Comments |
|---|---|---|---|
|
image_version
string
/ required
|
Image/software version to be installed on the F5OS device.
|
||
|
partition_name
string
|
Partition Name for which ISO image version is to be installed or upgraded.
|
||
|
state
string
|
|
If
install, starts the installation of the system image on the F5OS device.If
present, checks for the status of the installation of the system image and waits for completion.If
absent, presently this option is not supported.It will not remove the image from the device/uninstall the image. |
|
|
timeout
integer
|
Default: 300
|
The number of seconds to wait for software installation to complete.
The accepted value range is between
150 and 3600 seconds. |
Notes¶
Note
- Presently, the
absentoption is not supported. It will not remove the image from the device/uninstall the image.
Examples¶
- name: Install Software Image
f5os_system_image_install:
image_version: "1.8.0-13846"
state: install
- name: check status of Image Install
f5os_system_image_install:
image_version: "1.8.0-13846"
state: install
timeout: 600
- name: Update Partition Image Version
f5os_system_image_install:
partition_name: test100GbEoptics
image_version: "1.6.2-30244"
state: install
timeout: 600
- name: check status of Image Install
f5os_system_image_install:
partition_name: test100GbEoptics
image_version: "1.6.2-30244"
state: present
timeout: 600
Return Values¶
The following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
image_version
string
|
changed |
Image/software version to be installed on the F5OS device.
|