f5networks.f5_bigip.velos_partition_image (1.13.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5_bigip:==1.13.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_bigip
      version: 1.13.0

Description

Manage VELOS chassis partition images.

Usage examples

Scanned by Steampunk Spotter

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

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

  tasks:
    - 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
        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

Inputs

    
state:
    choices:
    - import
    - present
    - absent
    default: import
    description:
    - The partition 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 partition image if it exists.
    type: str

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

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

image_name:
    description:
    - Name of the partition image.
    - 'The value must follow original F5 ISO naming pattern: C(F5OS-C-) if C(iso_version)
      is not provided.'
    required: true
    type: str

iso_version:
    description:
    - The F5OS-C OS version.
    - When not provided, the value is extracted from the provided C(image_name).
    type: str

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

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

remote_port:
    description:
    - The port to connect to on the remote host.
    - 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 partition image is stored.
    type: str

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

Outputs

image_name:
  description: Name of the partition image.
  example: F5OS-C-1.1.0-3198.PARTITION.iso
  returned: changed
  type: str
iso_version:
  description: Version of the ISO image.
  returned: changed
  sample: 1.1.0-3198
  type: dict
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 partition image on the remote server.
  example: /foo/bar/
  returned: changed
  type: str
remote_port:
  description: The port to connect to on the remote host.
  example: 443
  returned: changed
  type: int