lix_fortinet.fortios.fortios_certificate_crl (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify certificate feature and crl category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

• ansible>=2.9

Usage examples

Scanned by Steampunk Spotter

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

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Certificate Revocation List as a PEM file.
    fortios_certificate_crl:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      certificate_crl:
        crl: "<your_own_value>"
        http_url: "<your_own_value>"
        last_updated: "2147483647"
        ldap_password: "<your_own_value>"
        ldap_server: "<your_own_value>"
        ldap_username: "<your_own_value>"
        name: "default_name_9"
        range: "global"
        scep_cert: "<your_own_value> (source certificate.local.name)"
        scep_url: "<your_own_value>"
        source: "factory"
        source_ip: "84.230.14.43"
        update_interval: "0"
        update_vdom: "<your_own_value> (source system.vdom.name)"

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

certificate_crl:
    default: null
    description:
    - Certificate Revocation List as a PEM file.
    suboptions:
      crl:
        description:
        - Certificate Revocation List as a PEM file.
        type: str
      http_url:
        description:
        - HTTP server URL for CRL auto-update.
        type: str
      last_updated:
        description:
        - Time at which CRL was last updated.
        type: int
      ldap_password:
        description:
        - LDAP server user password.
        type: str
      ldap_server:
        description:
        - LDAP server name for CRL auto-update.
        type: str
      ldap_username:
        description:
        - LDAP server user name.
        type: str
      name:
        description:
        - Name.
        required: true
        type: str
      range:
        choices:
        - global
        - vdom
        description:
        - Either global or VDOM IP address range for the certificate.
        type: str
      scep_cert:
        description:
        - Local certificate for SCEP communication for CRL auto-update. Source certificate.local.name.
        type: str
      scep_url:
        description:
        - SCEP server URL for CRL auto-update.
        type: str
      source:
        choices:
        - factory
        - user
        - bundle
        description:
        - Certificate source type.
        type: str
      source_ip:
        description:
        - Source IP address for communications to a HTTP or SCEP CA server.
        type: str
      update_interval:
        description:
        - Time in seconds before the FortiGate checks for an updated CRL. Set to 0 to
          update only when it expires.
        type: int
      update_vdom:
        description:
        - VDOM for CRL update. Source system.vdom.name.
        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