drmofu.fortimanager.fmgr_pkg_authentication_setting (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: Configure authentication setting.
      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: <value of string>
            auth-https: <value in [disable, enable]>
            captive-portal: <value of string>
            captive-portal-ip: <value of string>
            captive-portal-ip6: <value of string>
            captive-portal-port: <value of integer>
            captive-portal-ssl-port: <value of integer>
            captive-portal-type: <value in [fqdn, ip]>
            captive-portal6: <value of string>
            rewrite-https-port: <value of integer>
            sso-auth-scheme: <value of string>
            dev-range: <value of string>
            user-cert-ca: <value of string>
            cert-auth: <value in [disable, enable]>
            cert-captive-portal: <value of string>
            cert-captive-portal-ip: <value of string>
            cert-captive-portal-port: <value of integer>
            cookie-max-age: <value of integer>
            cookie-refresh-div: <value of integer>
            ip-auth-cookie: <value in [disable, enable]>
            persistent-cookie: <value in [disable, enable]>
            update-time: <value of 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
    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

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

pkg_authentication_setting:
    description: the top level parameters set
    required: false
    suboptions:
      active-auth-scheme:
        description: Active authentication method
        type: str
      auth-https:
        choices:
        - disable
        - enable
        description: Enable/disable redirecting HTTP user authentication to HTTPS.
        type: str
      captive-portal:
        description: Captive portal host name.
        type: str
      captive-portal-ip:
        description: Captive portal IP address.
        type: str
      captive-portal-ip6:
        description: Captive portal IPv6 address.
        type: str
      captive-portal-port:
        description: Captive portal port number
        type: int
      captive-portal-ssl-port:
        description: Captive portal SSL port number
        type: int
      captive-portal-type:
        choices:
        - fqdn
        - ip
        description: Captive portal type.
        type: str
      captive-portal6:
        description: IPv6 captive portal host name.
        type: str
      cert-auth:
        choices:
        - disable
        - enable
        description: Enable/disable redirecting certificate authentication to HTTPS portal.
        type: str
      cert-captive-portal:
        description: Certificate captive portal host name.
        type: str
      cert-captive-portal-ip:
        description: Certificate captive portal IP address.
        type: str
      cert-captive-portal-port:
        description: Certificate captive portal port number
        type: int
      cookie-max-age:
        description: Persistent web portal cookie maximum age in minutes
        type: int
      cookie-refresh-div:
        description: Refresh rate divider of persistent web portal cookie
        type: int
      dev-range:
        description: Address range for the IP based device query.
        type: str
      ip-auth-cookie:
        choices:
        - disable
        - enable
        description: Enable/disable persistent cookie on IP based web portal authentication
        type: str
      persistent-cookie:
        choices:
        - disable
        - enable
        description: Enable/disable persistent cookie on web portal authentication
        type: str
      rewrite-https-port:
        description: Rewrite to HTTPS port
        type: int
      sso-auth-scheme:
        description: Single-Sign-On authentication method
        type: str
      update-time:
        description: Time of the last update.
        type: str
      user-cert-ca:
        description: CA certificate used for client certificate verification.
        type: str
    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