f5networks.f5os.f5os_tenant_image (1.7.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5os:==1.7.0

Add to requirements.yml

  collections:
    - name: f5networks.f5os
      version: 1.7.0

Description

Manage F5OS tenant images.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
state:
    choices:
    - import
    - present
    - absent
    default: import
    description:
    - The tenant image state.
    - If C(import), starts the image import task if the image does not exist.
    - If C(present), checks for the status of the import task if the image does not exist.
    - If C(absent), deletes the tenant image if it exists.
    type: str

timeout:
    default: 300
    description:
    - The number of seconds to wait for image import to finish.
    - The accepted value range is between C(150) and C(3600) seconds.
    type: int

protocol:
    choices:
    - scp
    - sftp
    - https
    default: scp
    description:
    - Protocol for image transfer.
    type: str

image_name:
    description:
    - Name of the tenant image.
    required: true
    type: str

local_path:
    choices:
    - images/import
    - images/staging
    - images/tenant
    - images
    description:
    - The path on the F5OS where the the tenant image is to be uploaded.
    type: str

remote_host:
    description:
    - 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 C(protocol).
    type: str

remote_path:
    description:
    - The path to the tenant image on the remote server.
    type: path

remote_port:
    description:
    - The port on the remote host to which you want to connect.
    - If the port is not provided, a default port for the selected C(protocol) is used.
    type: int

remote_user:
    description:
    - User name for the remote server on which the tenant image is stored.
    type: str

remote_password:
    description:
    - Password for the user on the remote server on which the tenant image is stored.
    type: str

Outputs

image_name:
  description: Name of the tenant image.
  example: BIGIP-bigip14.1.x-miro-14.1.2.5-0.0.336.ALL-VELOS.qcow2.zip
  returned: changed
  type: str
local_path:
  description: The path on F5OS device where the tenant image will be uploaded.
  example: images/tenant
  returned: changed
  type: str
message:
  description: Informative message of the image import status.
  returned: changed
  sample: Import success
  type: dict
remote_host:
  description: The hostname or IP address of the remote server.
  example: foo.bar.baz.net
  returned: changed
  type: str
remote_path:
  description: The path to the tenant image on the remote server.
  example: /foo/bar/
  returned: changed
  type: str
remote_port:
  description: The port on the remote host to which you want to connect.
  example: 443
  returned: changed
  type: int