cm_files – Manage files uploads/deletes on BIG-IP Next CM

New in version 1.0.0.

Synopsis

  • Manage files uploads/deletes on BIG-IP Next CM

Parameters

Parameter Choices/Defaults Configuration Comments
description
string
The description of the uploaded file as it should appear on the CM.
filename
path / required
The path and filename of the file to be uploaded.
force
boolean
    Choices:
  • no ←
  • yes
When true, uploads the file every time and replaces the file on the CM.
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 CM.
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 CM.
The accepted value range is between 150 and 3600 seconds.

Examples

- name: Upload files to CM(Central Manager)
  cm_files:
    filename: "/path/to/file/file.json"
    description: "some file"
    timeout: 600

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

- name: Remove a file
  cm_files:
    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 CM.

Sample:
this is my file
filename
string
changed
The path and filename of the file to be uploaded to CM.

Sample:
/path/to/file.tar
name
string
changed
The name of the file as it should appear on the CM.

Sample:
my_file.tar


Status

Authors

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