sophos.sophos_firewall.sfos_authentication_edirectory module – Manage Authentication settings eDirectory

Note

This module is part of the sophos.sophos_firewall collection (version 2.0.1).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install sophos.sophos_firewall. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: sophos.sophos_firewall.sfos_authentication_edirectory.

New in sophos.sophos_firewall 1.3.0

Synopsis

  • Manage authentication servers (Configure > Authentication > Servers> Add) on Sophos Firewall

Requirements

The below requirements are needed on the host that executes this module.

  • sophosfirewall-python

  • Beginning in version 2.0.0, this module requires use of an httpapi connection plugin. See the HTTPAPI example for details.

Parameters

Parameter

Comments

basedn

string

BaseDN

binddn

string

Bind Username CN=user1,CN=Users,DC=example,DC=com

clientcertificate

string

Client Certificate type

connectionsecurity

string

Encryption

Choices:

  • "Simple"

  • "SSL"

  • "TLS"

dn_password

string

password for bind

port_edir

string

Port

serveripdomain

string

Server IP Address

servername

string

Name of Server

state

string / required

Use query to retrieve, updated to create, absent to remove, or updated to modify

Choices:

  • "absent"

  • "updated"

  • "query"

validateservercertificate

string

Validate Server Certificate

Choices:

  • "Enable"

  • "Disable"

Examples

- name: Update eDirectory
  sophos.sophos_firewall.sfos_authentication_edirectory:
    servername: Test
    serveripdomain: '192.168.0.1'
    port_edir: '1812'
    binddn: CN=user1,CN=Users,DC=example,DC=com
    dn_password: testtest
    connectionsecurity: TLS
    validateservercertificate: Enable
    clientcertificate: Webadmin
    basedn: o=sophos.com
    state: updated

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

api_response

dictionary

Serialized object containing the API response.

Returned: always

Authors

  • Matt Mullen (@mamullen13316)

  • Philip Finucane (@philfinucane)