ansible.builtin.fortios_vpn_ipsec_manualkey_interface (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to set and modify vpn_ipsec feature and manualkey_interface category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

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

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure IPsec manual keys.
    fortios_vpn_ipsec_manualkey_interface:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      vpn_ipsec_manualkey_interface:
        state: "present"
        addr-type: "4"
        auth-alg: "null"
        auth-key: "<your_own_value>"
        enc-alg: "null"
        enc-key: "<your_own_value>"
        interface: "<your_own_value> (source system.interface.name)"
        ip-version: "4"
        local-gw: "<your_own_value>"
        local-gw6: "<your_own_value>"
        local-spi: "<your_own_value>"
        name: "default_name_13"
        npu-offload: "enable"
        remote-gw: "<your_own_value>"
        remote-gw6: "<your_own_value>"
        remote-spi: "<your_own_value>"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

vpn_ipsec_manualkey_interface:
    default: null
    description:
    - Configure IPsec manual keys.
    suboptions:
      addr-type:
        choices:
        - 4
        - 6
        description:
        - IP version to use for IP packets.
      auth-alg:
        choices:
        - null
        - md5
        - sha1
        - sha256
        - sha384
        - sha512
        description:
        - Authentication algorithm. Must be the same for both ends of the tunnel.
      auth-key:
        description:
        - Hexadecimal authentication key in 16-digit (8-byte) segments separated by hyphens.
      enc-alg:
        choices:
        - null
        - des
        description:
        - Encryption algorithm. Must be the same for both ends of the tunnel.
      enc-key:
        description:
        - Hexadecimal encryption key in 16-digit (8-byte) segments separated by hyphens.
      interface:
        description:
        - Name of the physical, aggregate, or VLAN interface. Source system.interface.name.
      ip-version:
        choices:
        - 4
        - 6
        description:
        - IP version to use for VPN interface.
      local-gw:
        description:
        - IPv4 address of the local gateway's external interface.
      local-gw6:
        description:
        - Local IPv6 address of VPN gateway.
      local-spi:
        description:
        - Local SPI, a hexadecimal 8-digit (4-byte) tag. Discerns between two traffic
          streams with different encryption rules.
      name:
        description:
        - IPsec tunnel name.
        required: true
      npu-offload:
        choices:
        - enable
        - disable
        description:
        - Enable/disable offloading IPsec VPN manual key sessions to NPUs.
      remote-gw:
        description:
        - IPv4 address of the remote gateway's external interface.
      remote-gw6:
        description:
        - Remote IPv6 address of VPN gateway.
      remote-spi:
        description:
        - Remote SPI, a hexadecimal 8-digit (4-byte) tag. Discerns between two traffic
          streams with different encryption rules.
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str