sophos.sophos_firewall.sfos_authentication_ad module – Manage Authentication settings Active Directory

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_ad.

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

AD_Password

string

Password

ADSUsername

string

ADS user name

ConnectionSecurity

string

Connection security

Choices:

  • "Simple"

  • "StartTLS"

  • "SSL"

DisplayNameAttribute

string

Display name attribute

DomainName

string

Domain name

EmailAddressAttribute

string

Email address attribute

NetBIOSDomain

string

NetBIOS Domain

port

string

Directory tenant ID

SearchQueries

list / elements=string

Search queries

ServerAddress

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"

ValidCertReq

string

enable accounting

Choices:

  • "Enable"

  • "Disable"

Examples

- name: Update Active Directory Auth
  sophos.sophos_firewall.sfos_authentication_ad:
    servername: Test
    serveraddress: '192.168.0.1'
    ad_port: '636'
    netbiosdomain: test.sophos.com
    adsusername: admin
    ad_password: testtest
    connectionsecurity: SSL
    validcertreq: Disable
    displaynameattribute: dn
    emailaddressattribute: mail
    domainname: sophos.com
    searchqueries:
        - dc=sophos,dc=com
        - dc=sophos,dc=ie
    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)