fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_ssh (2.4.0) — module

Configure SFTP and SCP protocol options.

| "added in version" 2.1.0 of fortinet.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

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

  • 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 SFTP and SCP protocol options.
      fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_ssh:
        # 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>
        profile_protocol_options: <your own value>
        firewall_profileprotocoloptions_ssh:
          comfort_amount: <integer>
          comfort_interval: <integer>
          options:
            - oversize
            - clientcomfort
            - servercomfort
          oversize_limit: <integer>
          scan_bzip2: <value in [disable, enable]>
          uncompressed_nest_limit: <integer>
          uncompressed_oversize_limit: <integer>
          ssl_offloaded: <value in [no, yes]>
          stream_based_uncompressed_limit: <integer>
          tcp_window_maximum: <integer>
          tcp_window_minimum: <integer>
          tcp_window_size: <integer>
          tcp_window_type: <value in [system, static, dynamic, ...]>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    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

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

profile-protocol-options:
    description: Deprecated, please use "profile_protocol_options"
    type: str

profile_protocol_options:
    description: The parameter (profile-protocol-options) in requested url.
    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

firewall_profileprotocoloptions_ssh:
    description: The top level parameters set.
    required: false
    suboptions:
      comfort-amount:
        description: Deprecated, please rename it to comfort_amount. Amount of data to
          send in a transmission for client comforting
        type: int
      comfort-interval:
        description: Deprecated, please rename it to comfort_interval. Period of time
          between start, or last transmission, and the next client ...
        type: int
      options:
        choices:
        - oversize
        - clientcomfort
        - servercomfort
        description: No description.
        elements: str
        type: list
      oversize-limit:
        description: Deprecated, please rename it to oversize_limit. Maximum in-memory
          file size that can be scanned
        type: int
      scan-bzip2:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to scan_bzip2. Enable/disable scanning
          of BZip2 compressed files.
        type: str
      ssl-offloaded:
        choices:
        - 'no'
        - 'yes'
        description: Deprecated, please rename it to ssl_offloaded. SSL decryption and
          encryption performed by an external device.
        type: str
      stream-based-uncompressed-limit:
        description: Deprecated, please rename it to stream_based_uncompressed_limit.
          Maximum stream-based uncompressed data size that will be ...
        type: int
      tcp-window-maximum:
        description: Deprecated, please rename it to tcp_window_maximum. Maximum dynamic
          TCP window size.
        type: int
      tcp-window-minimum:
        description: Deprecated, please rename it to tcp_window_minimum. Minimum dynamic
          TCP window size.
        type: int
      tcp-window-size:
        description: Deprecated, please rename it to tcp_window_size. Set TCP static window
          size.
        type: int
      tcp-window-type:
        choices:
        - system
        - static
        - dynamic
        - auto-tuning
        description: Deprecated, please rename it to tcp_window_type. TCP window type
          to use for this protocol.
        type: str
      uncompressed-nest-limit:
        description: Deprecated, please rename it to uncompressed_nest_limit. Maximum
          nested levels of compression that can be uncompressed and...
        type: int
      uncompressed-oversize-limit:
        description: Deprecated, please rename it to uncompressed_oversize_limit. Maximum
          in-memory uncompressed file size that can be scanned
        type: int
    type: dict

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