f5os_system_image_import – Manage F5OS System image import.

New in version 1.11.0.

Synopsis

  • Manage the import of system images onto F5OS devices.

Parameters

Parameter Choices/Defaults Configuration Comments
local_path
string
    Choices:
  • images/import
  • images/staging
  • images/tenant
  • images
The path on the F5OS where the the system image will be imported.
operation_id
string
The import operation ID of the image import task.
remote_image_url
string / required
The path/url to the system image on the remote server.
remote_password
string
Provide the remote system password where the system image is stored.
remote_user
string
Provide the remote system username where the system image is stored.
state
string
    Choices:
  • import ←
  • present
  • absent
The tenant image state.
If import, starts the image import task if the image does not exist.
If present, checks for the status of the import operation if the image does not exist.
If absent, deletes the system 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

  • Repeating the same image import task immediately after the previous is not idempotent if the image has not finished downloading.

Examples

- name: Import system image 'foo' onto the F5OS device
  f5os_system_image_import:
    remote_image_url: https://foo.bar.baz.net/foo/bar/F5OS-A-1.8.0-14139.R5R10.CANDIDATE.iso
    local_path: images/staging
    state: import

- name: Check the status of the image import onto the F5OS device
  f5os_system_image_import:
    remote_image_url: https://foo.bar.baz.net/foo/bar/F5OS-A-1.8.0-14139.R5R10.CANDIDATE.iso
    local_path: images/staging
    operation_id: IMPORT-lZsT6P7M
    timeout: 600
    state: present

- name: Remove system image 'F5OS-A-1.8.0-14139.R5R10.CANDIDATE.iso' from the F5OS device
  f5os_system_image_import:
    remote_image_url: https://foo.bar.baz.net/foo/bar/F5OS-A-1.8.0-14139.R5R10.CANDIDATE.iso
    state: absent

Return Values

The following are the fields unique to this module:

Key Returned Description
local_path
string
changed
The path on the F5OS where the the system image will be imported.
operation_id
string
changed
Operation ID of the image import task.
remote_image_url
string
changed
The path/url to the system image on the remote server.


Status

Authors

  • Ravinder Reddy (@chinthalapalli)