drmofu.fortimanager.fmgr_vpn_certificate_ca (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

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

 - hosts: fortimanager-inventory
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: CA certificate.
      fmgr_vpn_certificate_ca:
         bypass_validation: False
         workspace_locking_adom: <value in [global, custom adom including root]>
         workspace_locking_timeout: 300
         rc_succeeded: [0, -2, -3, ...]
         rc_failed: [-2, -3, ...]
         adom: <your own value>
         state: <value in [present, absent]>
         vpn_certificate_ca:
            _private_key: <value of string>
            auto-update-days: <value of integer>
            auto-update-days-warning: <value of integer>
            ca: <value of string>
            last-updated: <value of integer>
            name: <value of string>
            range: <value in [global, vdom]>
            scep-url: <value of string>
            source: <value in [factory, user, bundle, ...]>
            source-ip: <value of string>
            trusted: <value in [disable, enable]>
            ssl-inspection-trusted: <value in [disable, enable]>
            ca-identifier: <value of string>
            obsolete: <value in [disable, enable]>

Inputs

    
adom:
    description: the parameter (adom) in requested url
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    required: false
    type: list

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

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    required: false
    type: bool

vpn_certificate_ca:
    description: the top level parameters set
    required: false
    suboptions:
      _private_key:
        description: _Private_Key.
        type: str
      auto-update-days:
        description: Number of days to wait before requesting an updated CA certificate
        type: int
      auto-update-days-warning:
        description: Number of days before an expiry-warning message is generated
        type: int
      ca:
        description: CA certificate as a PEM file.
        type: str
      ca-identifier:
        description: CA identifier of the SCEP server.
        type: str
      last-updated:
        description: Time at which CA was last updated.
        type: int
      name:
        description: Name.
        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
        - fortiguard
        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:
        - disable
        - enable
        description: Enable/disable this CA as a trusted CA for SSL inspection.
        type: str
      trusted:
        choices:
        - disable
        - enable
        description: Enable/disable as a trusted CA.
        type: str
    type: dict

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list