velos_tenant_image – Manage VELOS tenant images

New in version 1.1.0.

Synopsis

  • Manage VELOS tenant images.

Parameters

Parameter Choices/Defaults Configuration Comments
image_name
string / required
Name of the tenant image.
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 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 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 amount of time to wait for image import to finish, in seconds.
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

- 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.bigip
    ansible_httpapi_use_ssl: yes

  tasks:
    - name: Import tenant image 'foo' onto the Velos provider
      velos_tenant_image:
        image_name: foo
        remote_host: builds.mydomain.com
        remote_user: admin
        remote_password: secret
        remote_path: /images/
        state: import

    - name: Check the status of the image import onto the Velos provider
      velos_tenant_image:
        image_name: foo
        timeout: 600
        state: present

    - name: Remove tenant image 'foo'
      velos_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.

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 to connect to on the remote host.



Status

Authors

  • Wojciech Wypior (@wojtek0806)