community.network.ftd_configuration module – Manages configuration on Cisco FTD devices over REST API
Note
This module is part of the community.network collection (version 5.1.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.ftd_configuration
.
Note
The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.
DEPRECATED
- Removed in:
version 6.0.0
- Why:
This collection and all content in it is unmaintained and deprecated.
- Alternative:
Unknown.
Synopsis
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.
Aliases: network.ftd.ftd_configuration
Parameters
Parameter |
Comments |
---|---|
Key-value pairs that should be sent as body parameters in a REST API call |
|
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. |
|
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. |
|
Key-value pairs that should be sent as path parameters in a REST API call. |
|
Key-value pairs that should be sent as query parameters in a REST API call. |
|
Specifies Ansible fact name that is used to register received response from the FTD device. |
Examples
- name: Create a network object
community.network.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"
- name: Delete the network object
community.network.ftd_configuration:
operation: "deleteNetworkObject"
path_params:
objId: "{{ hostNetwork['id'] }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
HTTP response returned from the API call. Returned: success |
Status
This module will be removed in version 6.0.0. [deprecated]
For more information see DEPRECATED.