velos_partition_image – Manage VELOS chassis partition images¶
New in version 1.1.0.
DEPRECATED¶
Removed in F5 BIGIP Collection version: | |
---|---|
2.0.0 | |
Why: | All VELOS related modules have been moved to a dedicated collection for managing F5OS based devices. |
Alternative: | Use f5networks.f5os.velos_partition_image instead. |
Parameters¶
Parameter | Choices/Defaults | Configuration | Comments |
---|---|---|---|
image_name
string
/ required
|
Name of the partition image.
The value must follow original F5 ISO naming pattern:
F5OS-C- if iso_version is not provided. |
||
iso_version
string
|
The F5OS-C OS version.
When not provided, the value is extracted from the provided
image_name . |
||
protocol
string
|
|
Protocol to be used for image transfer.
|
|
remote_host
string
|
The hostname or IP address of the remote server on which the partition image is stored.
The server must make the image accessible via the specified
protocol . |
||
remote_password
string
|
Password for the user on the remote server on which the partition image is stored.
|
||
remote_path
path
|
The path to the partition image on the remote server.
|
||
remote_port
integer
|
The port to connect to on the remote host.
If the port is not provided, a default port for the selected
protocol is used. |
||
remote_user
string
|
User name for the remote server on which the partition image is stored.
|
||
state
string
|
|
The partition image state.
If
import , starts the image import task if the image does not exist.If
present , checks for the status of the import task if the image does not exist.If
absent , deletes the partition image if it exists. |
|
timeout
integer
|
Default: 300
|
The amount of time to wait for image import to finish, in seconds.
The accepted value range is between
150 and 3600 seconds. |
Notes¶
Note
- It can take up to 20 minutes for the image to register on the device after successful upload.
- As there is no way to check the internal ISO import progress yet, users should assume if the image ISO has not been found by this module when running the module with
state
set topresent
and 20 minutes has passed since it was uploaded, the internal import failed. The most common reason for this failure is ISO image corruption.
Examples¶
- hosts: all
collections:
- f5networks.f5_bigip
connection: httpapi
vars:
ansible_host: "lb.mydomain.com"
ansible_user: "admin"
ansible_httpapi_password: "secret"
ansible_network_os: f5networks.f5_bigip.velos
ansible_httpapi_use_ssl: yes
tasks:
- name: Import partition image onto the Velos controller
velos_partition_image:
image_name: F5OS-C-1.1.0-3198.PARTITION.iso
remote_host: builds.mydomain.com
remote_user: admin
remote_password: secret
remote_path: /images/
state: import
- name: Check for presence of the imported ISO on the Velos controller
velos_partition_image:
image_name: F5OS-C-1.1.0-3198.PARTITION.iso
timeout: 600
state: present
- name: Remove partition image from the Velos controller
velos_partition_image:
image_name: F5OS-C-1.1.0-3198.PARTITION.iso
state: absent
Return Values¶
The following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
image_name
string
|
changed |
Name of the partition image.
|
iso_version
dictionary
|
changed |
Version of the ISO image.
Sample:
1.1.0-3198
|
message
dictionary
|
changed |
Informative message of the image import status.
Sample:
Import success
|
remote_host
string
|
changed |
The hostname or IP address of the remote server.
|
remote_path
string
|
changed |
The path to the partition image on the remote server.
|
remote_port
integer
|
changed |
The port to connect to on the remote host.
|
Status¶
- This module will be removed in version 2.0.0. [deprecated]
- For more information see DEPRECATED.
Authors¶
- Wojciech Wypior (@wojtek0806)