microsoft.ad.as_sid filter – Converts an LDAP value to a Security Identifier string

Note

This filter plugin is part of the microsoft.ad collection (version 1.4.1).

You might already have this collection installed if you are using the ansible package. 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 microsoft.ad.

To use it in a playbook, specify: microsoft.ad.as_sid.

New in microsoft.ad 1.1.0

Synopsis

  • Converts an LDAP string or raw value to a security identifier string.

  • Should be used with the microsoft.ad.ldap plugin to convert attribute values to a security identifier string.

Input

This describes the input of the filter, the value before | microsoft.ad.as_sid.

Parameter

Comments

Input

any / required

The LDAP attribute bytes or string value representing a Security Identifier stored in LDAP.

If using a string as input, it must be a base64 string representing the SIDs bytes.

See Also

See also

microsoft.ad.as_datetime

microsoft.ad.as_datetime filter

microsoft.ad.as_guid

microsoft.ad.as_guid filter

microsoft.ad.ldap

microsoft.ad.ldap inventory

Examples

# This is an example used in the microsoft.ad.ldap plugin

attributes:
  objectSid: raw | microsoft.ad.as_sid

Return Value

Key

Description

Return value

string

The security identifier string value(s).

Returned: success

Authors

  • Jordan Borean (@jborean93)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.