fortinet.fortimanager.fmgr_icap_server (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

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.

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure ICAP servers.
      fortinet.fortimanager.fmgr_icap_server:
        # 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: present # <value in [present, absent]>
        icap_server:
          ip_address: <string>
          ip_version: <value in [4, 6]>
          ip6_address: <string>
          max_connections: <integer>
          name: <string>
          port: <integer>
          secure: <value in [disable, enable]>
          ssl_cert: <string>
          addr_type: <value in [fqdn, ip4, ip6]>
          fqdn: <string>
          healthcheck: <value in [disable, enable]>
          healthcheck_service: <string>

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
    type: list

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

icap_server:
    description: The top level parameters set.
    required: false
    suboptions:
      addr-type:
        choices:
        - fqdn
        - ip4
        - ip6
        description: Deprecated, please rename it to addr_type. Address type of the remote
          ICAP server
        type: str
      fqdn:
        description: ICAP remote server Fully Qualified Domain Name
        type: str
      healthcheck:
        choices:
        - disable
        - enable
        description: Enable/disable ICAP remote server health checking.
        type: str
      healthcheck-service:
        description: Deprecated, please rename it to healthcheck_service. ICAP Service
          name to use for health checks.
        type: str
      ip-address:
        description: Deprecated, please rename it to ip_address. IPv4 address of the ICAP
          server.
        type: str
      ip-version:
        choices:
        - '4'
        - '6'
        description: Deprecated, please rename it to ip_version. IP version.
        type: str
      ip6-address:
        description: Deprecated, please rename it to ip6_address. IPv6 address of the
          ICAP server.
        type: str
      max-connections:
        description: Deprecated, please rename it to max_connections. Maximum number of
          concurrent connections to ICAP server.
        type: int
      name:
        description: Server name.
        required: true
        type: str
      port:
        description: ICAP server port.
        type: int
      secure:
        choices:
        - disable
        - enable
        description: Enable/disable secure connection to ICAP server.
        type: str
      ssl-cert:
        description: Deprecated, please rename it to ssl_cert. CA certificate name.
        type: str
    type: dict

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

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

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    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.
    type: bool

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

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

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    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