Last updated on: 2024-04-01 03:24:20.

f5os_tenant_image – Manage F5OS tenant images

New in version 1.0.0.

Synopsis

  • Manage F5OS tenant images.

Parameters

Parameter Choices/Defaults Configuration Comments
image_name
string / required
Name of the tenant image.
local_path
string
    Choices:
  • images/import
  • images/staging
  • images/tenant
  • images
The path on the F5OS where the the tenant image is to be uploaded.
protocol
string
    Choices:
  • scp ←
  • sftp
  • https
Protocol for image transfer.
remote_host
string
The hostname or IP address of the remote server on which the tenant 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 tenant image is stored.
remote_path
path
The path to the tenant image on the remote server.
remote_port
integer
The port on the remote host to which you want to connect.
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 tenant 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 task if the image does not exist.
If absent, deletes the tenant 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.
  • This module will not execute on VELOS controller.

Examples

- name: Import tenant image 'foo' onto the F5OS device
  f5os_tenant_image:
    image_name: foo
    remote_host: builds.mydomain.com
    remote_user: admin
    remote_password: secret
    remote_path: /images/
    local_path: images/tenant
    state: import

- name: Check the status of the image import onto the F5OS device
  f5os_tenant_image:
    image_name: foo
    timeout: 600
    state: present

- name: Remove tenant image 'foo'
  f5os_tenant_image:
    name: foo
    state: absent

Return Values

The following are the fields unique to this module:

Key Returned Description
image_name
string
changed
Name of the tenant image.
local_path
string
changed
The path on F5OS device where the tenant image will be uploaded.
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 tenant image on the remote server.
remote_port
integer
changed
The port on the remote host to which you want to connect.


Status

Authors

  • Wojciech Wypior (@wojtek0806)