fortinet.fortios.fortios_vpn_certificate_ca (2.3.6) — module

CA certificate in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

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_certificate feature and ca category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: CA certificate.
  fortinet.fortios.fortios_vpn_certificate_ca:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_certificate_ca:
          auto_update_days: "0"
          auto_update_days_warning: "0"
          ca: "<your_own_value>"
          ca_identifier: "myId_6"
          est_url: "<your_own_value>"
          last_updated: "2147483647"
          name: "default_name_9"
          obsolete: "disable"
          range: "global"
          scep_url: "<your_own_value>"
          source: "factory"
          source_ip: "84.230.14.43"
          ssl_inspection_trusted: "enable"
          trusted: "enable"

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_certificate_ca:
    default: null
    description:
    - CA certificate.
    suboptions:
      auto_update_days:
        description:
        - Number of days to wait before requesting an updated CA certificate (0 - 4294967295,
          0 = disabled).
        type: int
      auto_update_days_warning:
        description:
        - Number of days before an expiry-warning message is generated (0 - 4294967295,
          0 = disabled).
        type: int
      ca:
        description:
        - CA certificate as a PEM file.
        type: str
      ca_identifier:
        description:
        - CA identifier of the SCEP server.
        type: str
      est_url:
        description:
        - URL of the EST server.
        type: str
      last_updated:
        description:
        - Time at which CA was last updated.
        type: int
      name:
        description:
        - Name.
        required: true
        type: str
      obsolete:
        choices:
        - disable
        - enable
        description:
        - Enable/disable this CA as obsoleted.
        type: str
      range:
        choices:
        - global
        - vdom
        description:
        - Either global or VDOM IP address range for the CA certificate.
        type: str
      scep_url:
        description:
        - URL of the SCEP server.
        type: str
      source:
        choices:
        - factory
        - user
        - bundle
        description:
        - CA certificate source type.
        type: str
      source_ip:
        description:
        - Source IP address for communications to the SCEP server.
        type: str
      ssl_inspection_trusted:
        choices:
        - enable
        - disable
        description:
        - Enable/disable this CA as a trusted CA for SSL inspection.
        type: str
      trusted:
        choices:
        - enable
        - disable
        description:
        - Enable/disable as a trusted CA.
        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