Module `sysbot.modules.windows.adds`

Active Directory Domain Services Module

This module provides methods for managing and querying Active Directory Domain Services (AD DS) including domains, forests, domain controllers, users, groups, computers, and organizational units using PowerShell AD cmdlets.

Classes

class Adds

Active Directory Domain Services management class using PowerShell AD cmdlets.

Ancestors

ComponentBase

Methods

def get_computer(self, alias: str, identity: str, **kwargs) ‑> dict

Get specific computer by identity.

Args

alias: Session alias for the connection.
identity: Computer identity (name, DN, GUID, or SID).
**kwargs: Additional command execution options.

Returns

Dictionary containing computer information with all properties.

def get_computers(self, alias: str, filter: str = '*', **kwargs) ‑> list

Get computers matching filter.

Args

alias: Session alias for the connection.
filter: LDAP filter string (default: "*" for all computers).
**kwargs: Additional command execution options.

Returns

List of dictionaries containing computer information.

def get_domain(self, alias: str, **kwargs) ‑> dict

Get domain information.

Args

alias: Session alias for the connection.
**kwargs: Additional command execution options.

Returns

Dictionary containing Active Directory domain information.

def get_domain_controller(self, alias: str, **kwargs) ‑> dict

Get domain controller information.

Args

alias: Session alias for the connection.
**kwargs: Additional command execution options.

Returns

Dictionary containing domain controller information.

def get_forest(self, alias: str, **kwargs) ‑> dict

Get forest information.

Args

alias: Session alias for the connection.
**kwargs: Additional command execution options.

Returns

Dictionary containing Active Directory forest information.

def get_gpo(self, alias: str, **kwargs) ‑> list

Get all Group Policy Objects.

Args

alias: Session alias for the connection.
**kwargs: Additional command execution options.

Returns

List of dictionaries containing GPO information.

def get_gpos(self, alias: str, **kwargs) ‑> list

Get all Group Policy Objects (alias for get_gpo).

Args

alias: Session alias for the connection.
**kwargs: Additional command execution options.

Returns

List of dictionaries containing GPO information.

def get_group(self, alias: str, identity: str, **kwargs) ‑> dict

Get specific group by identity.

Args

alias: Session alias for the connection.
identity: Group identity (name, DN, GUID, or SID).
**kwargs: Additional command execution options.

Returns

Dictionary containing group information with all properties.

def get_group_members(self, alias: str, identity: str, **kwargs) ‑> list

Get members of a group.

Args

alias: Session alias for the connection.
identity: Group identity (name, DN, GUID, or SID).
**kwargs: Additional command execution options.

Returns

List of dictionaries containing group member information.

def get_groups(self, alias: str, filter: str = '*', **kwargs) ‑> list

Get groups matching filter.

Args

alias: Session alias for the connection.
filter: LDAP filter string (default: "*" for all groups).
**kwargs: Additional command execution options.

Returns

List of dictionaries containing group information.

def get_organizational_unit(self, alias: str, identity: str, **kwargs) ‑> dict

Get specific organizational unit by identity.

Args

alias: Session alias for the connection.
identity: OU identity (name, DN, or GUID).
**kwargs: Additional command execution options.

Returns

Dictionary containing organizational unit information with all properties.

def get_organizational_units(self, alias: str, filter: str = '*', **kwargs) ‑> list

Get organizational units matching filter.

Args

alias: Session alias for the connection.
filter: LDAP filter string (default: "*" for all OUs).
**kwargs: Additional command execution options.

Returns

List of dictionaries containing organizational unit information.

def get_user(self, alias: str, identity: str, **kwargs) ‑> dict

Get specific user by identity.

Args

alias: Session alias for the connection.
identity: User identity (username, DN, GUID, or SID).
**kwargs: Additional command execution options.

Returns

Dictionary containing user information with all properties.

def get_users(self, alias: str, filter: str = '*', **kwargs) ‑> list

Get users matching filter.

Args

alias: Session alias for the connection.
filter: LDAP filter string (default: "*" for all users).
**kwargs: Additional command execution options.

Returns

List of dictionaries containing user information.