drmofu.fortimanager.fmgr_system_saml (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: Global settings for SAML authentication.
      fmgr_system_saml:
         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, ...]
         system_saml:
            acs-url: <value of string>
            cert: <value of string>
            entity-id: <value of string>
            idp-cert: <value of string>
            idp-entity-id: <value of string>
            idp-single-logout-url: <value of string>
            idp-single-sign-on-url: <value of string>
            login-auto-redirect: <value in [disable, enable]>
            role: <value in [IDP, SP, FAB-SP]>
            server-address: <value of string>
            service-providers:
              -
                  idp-entity-id: <value of string>
                  idp-single-logout-url: <value of string>
                  idp-single-sign-on-url: <value of string>
                  name: <value of string>
                  prefix: <value of string>
                  sp-cert: <value of string>
                  sp-entity-id: <value of string>
                  sp-single-logout-url: <value of string>
                  sp-single-sign-on-url: <value of string>
                  sp-adom: <value of string>
                  sp-profile: <value of string>
            sls-url: <value of string>
            status: <value in [disable, enable]>
            default-profile: <value of string>
            fabric-idp:
              -
                  dev-id: <value of string>
                  idp-cert: <value of string>
                  idp-entity-id: <value of string>
                  idp-single-logout-url: <value of string>
                  idp-single-sign-on-url: <value of string>
                  idp-status: <value in [disable, enable]>
            forticloud-sso: <value in [disable, enable]>
            user-auto-create: <value in [disable, enable]>
            auth-request-signed: <value in [disable, enable]>
            want-assertions-signed: <value in [disable, enable]>

Inputs

    
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

system_saml:
    description: the top level parameters set
    required: false
    suboptions:
      acs-url:
        description: SP ACS
        type: str
      auth-request-signed:
        choices:
        - disable
        - enable
        description:
        - Enable/Disable auth request signed.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      cert:
        description: Certificate name.
        type: str
      default-profile:
        description: Default Profile Name.
        type: str
      entity-id:
        description: SP entity ID.
        type: str
      fabric-idp:
        description: Fabric-Idp.
        elements: dict
        suboptions:
          dev-id:
            description: IDP Device ID.
            type: str
          idp-cert:
            description: IDP Certificate name.
            type: str
          idp-entity-id:
            description: IDP entity ID.
            type: str
          idp-single-logout-url:
            description: IDP single logout url.
            type: str
          idp-single-sign-on-url:
            description: IDP single sign-on URL.
            type: str
          idp-status:
            choices:
            - disable
            - enable
            description:
            - Enable/disable SAML authentication
            - disable - Disable SAML authentication.
            - enable - Enabld SAML authentication.
            type: str
        type: list
      forticloud-sso:
        choices:
        - disable
        - enable
        description:
        - Enable/disable FortiCloud SSO
        - disable - Disable Forticloud SSO.
        - enable - Enabld Forticloud SSO.
        type: str
      idp-cert:
        description: IDP Certificate name.
        type: str
      idp-entity-id:
        description: IDP entity ID.
        type: str
      idp-single-logout-url:
        description: IDP single logout url.
        type: str
      idp-single-sign-on-url:
        description: IDP single sign-on URL.
        type: str
      login-auto-redirect:
        choices:
        - disable
        - enable
        description:
        - Enable/Disable auto redirect to IDP login page.
        - disable - Disable auto redirect to IDP Login Page.
        - enable - Enable auto redirect to IDP Login Page.
        type: str
      role:
        choices:
        - IDP
        - SP
        - FAB-SP
        description:
        - SAML role.
        - IDP - IDentiy Provider.
        - SP - Service Provider.
        type: str
      server-address:
        description: server address.
        type: str
      service-providers:
        description: Service-Providers.
        elements: dict
        suboptions:
          idp-entity-id:
            description: IDP Entity ID.
            type: str
          idp-single-logout-url:
            description: IDP single logout url.
            type: str
          idp-single-sign-on-url:
            description: IDP single sign-on URL.
            type: str
          name:
            description: Name.
            type: str
          prefix:
            description: Prefix.
            type: str
          sp-adom:
            description: SP adom name.
            type: str
          sp-cert:
            description: SP certificate name.
            type: str
          sp-entity-id:
            description: SP Entity ID.
            type: str
          sp-profile:
            description: SP profile name.
            type: str
          sp-single-logout-url:
            description: SP single logout URL.
            type: str
          sp-single-sign-on-url:
            description: SP single sign-on URL.
            type: str
        type: list
      sls-url:
        description: SP SLS
        type: str
      status:
        choices:
        - disable
        - enable
        description:
        - Enable/disable SAML authentication
        - disable - Disable SAML authentication.
        - enable - Enabld SAML authentication.
        type: str
      user-auto-create:
        choices:
        - disable
        - enable
        description:
        - Enable/disable user auto creation
        - disable - Disable auto create user.
        - enable - Enable auto create user.
        type: str
      want-assertions-signed:
        choices:
        - disable
        - enable
        description:
        - Enable/Disable want assertions signed.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
    type: dict

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

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