fortinet.fortimanager.fmgr_pkg_authentication_setting (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 setting.
      fortinet.fortimanager.fmgr_pkg_authentication_setting:
        # 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>
        pkg_authentication_setting:
          active_auth_scheme: <string>
          auth_https: <value in [disable, enable]>
          captive_portal: <string>
          captive_portal_ip: <string>
          captive_portal_ip6: <string>
          captive_portal_port: <integer>
          captive_portal_ssl_port: <integer>
          captive_portal_type: <value in [fqdn, ip]>
          captive_portal6: <string>
          rewrite_https_port: <integer>
          sso_auth_scheme: <string>
          dev_range: <list or string>
          user_cert_ca: <list or string>
          cert_auth: <value in [disable, enable]>
          cert_captive_portal: <string>
          cert_captive_portal_ip: <string>
          cert_captive_portal_port: <integer>
          cookie_max_age: <integer>
          cookie_refresh_div: <integer>
          ip_auth_cookie: <value in [disable, enable]>
          persistent_cookie: <value in [disable, enable]>
          update_time: <string>

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

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

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

pkg_authentication_setting:
    description: The top level parameters set.
    required: false
    suboptions:
      active-auth-scheme:
        description: Deprecated, please rename it to active_auth_scheme. Active authentication
          method
        type: str
      auth-https:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to auth_https. Enable/disable redirecting
          HTTP user authentication to HTTPS.
        type: str
      captive-portal:
        description: Deprecated, please rename it to captive_portal. Captive portal host
          name.
        type: str
      captive-portal-ip:
        description: Deprecated, please rename it to captive_portal_ip. Captive portal
          IP address.
        type: str
      captive-portal-ip6:
        description: Deprecated, please rename it to captive_portal_ip6. Captive portal
          IPv6 address.
        type: str
      captive-portal-port:
        description: Deprecated, please rename it to captive_portal_port. Captive portal
          port number
        type: int
      captive-portal-ssl-port:
        description: Deprecated, please rename it to captive_portal_ssl_port. Captive
          portal SSL port number
        type: int
      captive-portal-type:
        choices:
        - fqdn
        - ip
        description: Deprecated, please rename it to captive_portal_type. Captive portal
          type.
        type: str
      captive-portal6:
        description: Deprecated, please rename it to captive_portal6. IPv6 captive portal
          host name.
        type: str
      cert-auth:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to cert_auth. Enable/disable redirecting
          certificate authentication to HTTPS portal.
        type: str
      cert-captive-portal:
        description: Deprecated, please rename it to cert_captive_portal. Certificate
          captive portal host name.
        type: str
      cert-captive-portal-ip:
        description: Deprecated, please rename it to cert_captive_portal_ip. Certificate
          captive portal IP address.
        type: str
      cert-captive-portal-port:
        description: Deprecated, please rename it to cert_captive_portal_port. Certificate
          captive portal port number
        type: int
      cookie-max-age:
        description: Deprecated, please rename it to cookie_max_age. Persistent web portal
          cookie maximum age in minutes
        type: int
      cookie-refresh-div:
        description: Deprecated, please rename it to cookie_refresh_div. Refresh rate
          divider of persistent web portal cookie
        type: int
      dev-range:
        description: (list or str) Deprecated, please rename it to dev_range. Address
          range for the IP based device query.
        type: raw
      ip-auth-cookie:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to ip_auth_cookie. Enable/disable persistent
          cookie on IP based web portal authentication
        type: str
      persistent-cookie:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to persistent_cookie. Enable/disable
          persistent cookie on web portal authentication
        type: str
      rewrite-https-port:
        description: Deprecated, please rename it to rewrite_https_port. Rewrite to HTTPS
          port
        type: int
      sso-auth-scheme:
        description: Deprecated, please rename it to sso_auth_scheme. Single-Sign-On authentication
          method
        type: str
      update-time:
        description: Deprecated, please rename it to update_time. Time of the last update.
        type: str
      user-cert-ca:
        description: (list or str) Deprecated, please rename it to user_cert_ca. CA certificate
          used for client certificate verification.
        type: raw
    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