fortinet.fortios.fortios_vpn_ipsec_manualkey_interface (2.3.6) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device 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.0

Requirements

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

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

- name: Configure IPsec manual keys.
  fortinet.fortios.fortios_vpn_ipsec_manualkey_interface:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_ipsec_manualkey_interface:
          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

    
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.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

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.
        type: str
      auth_alg:
        choices:
        - 'null'
        - md5
        - sha1
        - sha256
        - sha384
        - sha512
        description:
        - Authentication algorithm. Must be the same for both ends of the tunnel.
        type: str
      auth_key:
        description:
        - Hexadecimal authentication key in 16-digit (8-byte) segments separated by hyphens.
        type: str
      enc_alg:
        choices:
        - 'null'
        - des
        - 3des
        - aes128
        - aes192
        - aes256
        - aria128
        - aria192
        - aria256
        - seed
        description:
        - Encryption algorithm. Must be the same for both ends of the tunnel.
        type: str
      enc_key:
        description:
        - Hexadecimal encryption key in 16-digit (8-byte) segments separated by hyphens.
        type: str
      interface:
        description:
        - Name of the physical, aggregate, or VLAN interface. Source system.interface.name.
        type: str
      ip_version:
        choices:
        - '4'
        - '6'
        description:
        - IP version to use for VPN interface.
        type: str
      local_gw:
        description:
        - IPv4 address of the local gateway"s external interface.
        type: str
      local_gw6:
        description:
        - Local IPv6 address of VPN gateway.
        type: str
      local_spi:
        description:
        - Local SPI, a hexadecimal 8-digit (4-byte) tag. Discerns between two traffic
          streams with different encryption rules.
        type: str
      name:
        description:
        - IPsec tunnel name.
        required: true
        type: str
      npu_offload:
        choices:
        - enable
        - disable
        description:
        - Enable/disable offloading IPsec VPN manual key sessions to NPUs.
        type: str
      remote_gw:
        description:
        - IPv4 address of the remote gateway"s external interface.
        type: str
      remote_gw6:
        description:
        - Remote IPv6 address of VPN gateway.
        type: str
      remote_spi:
        description:
        - Remote SPI, a hexadecimal 8-digit (4-byte) tag. Discerns between two traffic
          streams with different encryption rules.
        type: str
    type: dict

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