f5networks.f5_bigip.bigip_config (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

Manages a BIG-IP configuration. Allows for merge of SCF formatted files into the running configuration.

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

  tasks:
    - name: Save the running configuration of the BIG-IP
      bigip_config:
        save: yes
      register: task

    - name: Check for task completion
      bigip_config:
        task_id: "{{ task.task_id }}"
        timeout: 150

    - name: Reset the BIG-IP configuration, for example, to RMA the device
      bigip_config:
        reset: yes
      register: task

    - name: Change connection password after config was reset
      set_fact:
        ansible_httpapi_password: "default"

    - name: Check for reset task completion
      bigip_config:
        task_id: "{{ task.task_id }}"
        timeout: 150

    - name: Save the running configuration of the BIG-IP after reset
      bigip_config:
        save: yes
      register: task

    - name: Check for save config task completion after reset
      bigip_config:
        task_id: "{{ task.task_id }}"
        timeout: 150

    - name: Load an SCF configuration
      bigip_config:
        merge_content: "{{ role_path }}/files/config.scf') }}"
      register: task

    - name: Check for merge config task completion
      bigip_config:
        task_id: "{{ task.task_id }}"
        timeout: 150

    - name: Verify an SCF configuration merge validity
      bigip_config:
        merge_content: "{{ role_path }}/files/config.scf') }}"
        validate: true

Inputs

    
save:
    default: false
    description:
    - The C(save) argument instructs the module to save the running-config to startup-config.
    type: bool

reset:
    default: false
    description:
    - Loads the default configuration on the device.
    - If this option is specified, the default configuration is loaded.
    - On TMOS v14.0.0 and up, resetting to the default configuration resets the admin
      and user password to the defaults. Restarts services, which leads to 503 server
      errors followed by 401 authorization errors during module execution. We recommend
      changing the C(ansible_httpapi_password) before checking for the reset task state.
    type: bool

verify:
    default: false
    description:
    - Validates the specified configuration to see whether it is valid to replace the
      running configuration.
    - The running configuration will not be changed.
    - When this parameter is set to C(yes), no change is reported by the module.
    - Verifies the operation is synchronous and does not require checking for task completion.
    type: bool

task_id:
    description:
    - The ID of the async task as returned by the system in a previous module run.
    - Used to query the status of the task on the device.
    - When this parameter is set, all other module parameters are ignored.
    type: str

timeout:
    default: 150
    description:
    - The amount of time to wait for the DO async interface to complete its task, in seconds.
    - The accepted value range is between C(150) and C(3600) seconds.
    type: int

merge_content:
    description:
    - The file that contains desired configuration to be merged.
    - Loads the specified configuration from a file to merge into the running configuration.
    type: path

Outputs

message:
  description: Informative message.
  returned: always
  sample: Verification is successful
  type: dict
task_id:
  description: The task ID returned by the system.
  returned: changed
  sample: hash/dictionary of values
  type: dict