fortinet.fortimanager.fmgr_pkg_authentication_rule (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 Authentication Rules.
      fortinet.fortimanager.fmgr_pkg_authentication_rule:
        # 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>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_authentication_rule:
          active_auth_method: <string>
          comments: <string>
          ip_based: <value in [disable, enable]>
          name: <string>
          protocol: <value in [http, ftp, socks, ...]>
          srcaddr: <list or string>
          srcaddr6: <list or string>
          sso_auth_method: <string>
          status: <value in [disable, enable]>
          transaction_based: <value in [disable, enable]>
          web_auth_cookie: <value in [disable, enable]>
          web_portal: <value in [disable, enable]>
          dstaddr: <list or string>
          dstaddr6: <list or string>
          srcintf: <list or string>
          cors_depth: <integer>
          cors_stateful: <value in [disable, enable]>

Inputs

    
pkg:
    description: The parameter (pkg) in requested url.
    required: true
    type: str

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

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

pkg_authentication_rule:
    description: The top level parameters set.
    required: false
    suboptions:
      active-auth-method:
        description: Deprecated, please rename it to active_auth_method. Select an active
          authentication method.
        type: str
      comments:
        description: Comment.
        type: str
      cors-depth:
        description: Deprecated, please rename it to cors_depth. Depth to allow CORS access
        type: int
      cors-stateful:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to cors_stateful. Enable/disable allowance
          of CORS access
        type: str
      dstaddr:
        description: (list or str) Select an IPv4 destination address from available options.
        type: raw
      dstaddr6:
        description: (list or str) Select an IPv6 destination address from available options.
        type: raw
      ip-based:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ip_based. Enable/disable IP-based
          authentication.
        type: str
      name:
        description: Authentication rule name.
        required: true
        type: str
      protocol:
        choices:
        - http
        - ftp
        - socks
        - ssh
        description: Select the protocol to use for authentication
        type: str
      srcaddr:
        description: (list or str) Select an IPv4 source address from available options.
        type: raw
      srcaddr6:
        description: (list or str) Select an IPv6 source address.
        type: raw
      srcintf:
        description: (list or str) Incoming
        type: raw
      sso-auth-method:
        description: Deprecated, please rename it to sso_auth_method. Select a single-sign
          on
        type: str
      status:
        choices:
        - disable
        - enable
        description: Enable/disable this authentication rule.
        type: str
      transaction-based:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to transaction_based. Enable/disable
          transaction based authentication
        type: str
      web-auth-cookie:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to web_auth_cookie. Enable/disable Web
          authentication cookies
        type: str
      web-portal:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to web_portal. Enable/disable web portal
          for proxy transparent policy
        type: str
    type: dict

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