velos_partition_image – Manage VELOS chassis partition images

New in version 1.0.0.

Synopsis

  • Manage VELOS chassis partition images.

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
    Choices:
  • scp ←
  • sftp
  • https
Protocol to be used for image transfer.
The parameter is required when other than default when state is present.
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.
The parameter is required when state is import or state is present.
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.
The parameter is required when state is import or state is present.
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
    Choices:
  • import ←
  • present
  • absent
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 number of seconds to wait for image import to finish.
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 to present and 20 minutes has passed since it was uploaded, the internal import failed. The most common reason for this failure is ISO image corruption.
  • This module supports only bundled type of F5OS images, unbundled types of images for OS or Services are not supported.

Examples

- 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
    remote_host: builds.mydomain.com
    remote_path: /images/
    protocol: scp
    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 F5OS 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

Authors

  • Wojciech Wypior (@wojtek0806)