cm_next_files – Manage BIG-IP Next instance files through CM

New in version 1.0.0.

Synopsis

  • Manage BIG-IP Next files through CM.

Parameters

Parameter Choices/Defaults Configuration Comments
description
string
The description of the uploaded file as it should appear on the BIG-IP Next instance.
device_hostname
string
The hostname of the BIG-IP Next instance to manage files on.
Parameter mutually exclusive with device_ip.
device_ip
string
The ip address of the BIG-IP Next instance to manage files on.
Parameter mutually exclusive with device_hostname.
filename
path / required
The path and filename of the file to be uploaded to BIG-IP Next instance.
force
boolean
    Choices:
  • no ←
  • yes
When true, uploads the file every time and replaces the file on the BIG-IP Next instance.
When false, the file is only uploaded if it does not already exist.
name
string
The name of the file as it should appear on the BIG-IP Next instance.
If not provided the parameter is inferred from filename.
state
string
    Choices:
  • absent
  • present ←
When present, ensures the file is uploaded.
When absent, ensures the file is removed.
timeout
integer
Default:
300
The amount of time in seconds to wait for the file to appear on BIG-IP Next instance.
The accepted value range is between 150 and 3600 seconds.

Examples

- name: Upgrade BIG-IP Next instance
  cm_next_files:
    device_ip: "127.1.1.1"
    filename: "/path/to/file/file.json"
    description: "some file"
    timeout: 600

- name: Upload a file - force on
  cm_next_files:
    device_ip: "127.1.1.1"
    filename: "/path/to/file/file.json"
    description: "some file"
    force: "yes"

- name: Remove a file
  cm_next_files:
    device_ip: "127.1.1.1"
    filename: "/path/to/file/file.json"
    state: absent

Return Values

The following are the fields unique to this module:

Key Returned Description
description
string
changed
The description of the uploaded file as it should appear on the BIG-IP Next instance.

Sample:
this is my file
device_hostname
string
changed
The hostname of the BIG-IP Next instance to manage files on.

Sample:
foo.bar.net
device_ip
string
changed
The ip address of the BIG-IP Next instance to manage files on.

Sample:
192.168.1.1
filename
string
changed
The path and filename of the file to be uploaded to BIG-IP Next instance.

Sample:
/path/to/file.tar
name
string
changed
The name of the file as it should appear on the BIG-IP Next instance.

Sample:
my_file.tar


Status

Authors

  • Ravinder Reddy (@RavinderReddyF5)
  • Wojciech Wypior (@wojtek0806)