community.general.ftd_configuration (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Manages configuration on Cisco FTD devices including creating, updating, removing configuration objects, scheduling and staring jobs, deploying pending changes, etc. All operations are performed over REST API.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create a network object
  ftd_configuration:
    operation: "addNetworkObject"
    data:
      name: "Ansible-network-host"
      description: "From Ansible with love"
      subType: "HOST"
      value: "192.168.2.0"
      dnsResolution: "IPV4_AND_IPV6"
      type: "networkobject"
      isSystemDefined: false
    register_as: "hostNetwork"

Scanned by Steampunk Spotter

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

- name: Delete the network object
  ftd_configuration:
    operation: "deleteNetworkObject"
    path_params:
      objId: "{{ hostNetwork['id'] }}"

Inputs

    
data:
    description:
    - Key-value pairs that should be sent as body parameters in a REST API call
    type: dict

filters:
    description:
    - Key-value dict that represents equality filters. Every key is a property name and
      value is its desired value. If multiple filters are present, they are combined with
      logical operator AND.
    type: dict

operation:
    description:
    - The name of the operation to execute. Commonly, the operation starts with 'add',
      'edit', 'get', 'upsert' or 'delete' verbs, but can have an arbitrary name too.
    required: true
    type: str

path_params:
    description:
    - Key-value pairs that should be sent as path parameters in a REST API call.
    type: dict

register_as:
    description:
    - Specifies Ansible fact name that is used to register received response from the
      FTD device.
    type: str

query_params:
    description:
    - Key-value pairs that should be sent as query parameters in a REST API call.
    type: dict

Outputs

response:
  description: HTTP response returned from the API call.
  returned: success
  type: dict