samba : API documentation

samba : package documentation

Samba 4.

Module	auth	Authentication and authorization support.
Module	com	Simple COM implementation
Module	common	No module docstring; 1/1 classes, 2/2 functions documented
Module	credentials	Credentials management.
Module	dbchecker	No module docstring; 1/1 classes documented
Package	dcerpc	No package docstring; 29/29 modules documented
Module	drs_utils	No module docstring; 2/2 classes, 4/4 functions documented
Module	dsdb	Python bindings for the directory service databases.
Module	gensec	Generic Security Interface.
Module	getopt	Support for parsing Samba-related command-line options.
Module	hostconfig	Local host configuration.
Module	idmap	Convenience functions for using the idmap database.
Module	join	Joining a domain.
Module	kcc_utils	No module docstring; 10/13 classes, 0/1 functions documented
Module	messaging	Internal RPC
Module	ms_display_specifiers	No module docstring; 6/6 functions documented
Module	ms_schema	Generate LDIF from WSPP documentation.
Module	ndr	Network Data Representation (NDR) marshalling and unmarshalling.
Module	net	Undocumented
Module	netbios	NetBIOS over TCP/IP support
Package	netcmd	No package docstring; 1/20 modules documented
Module	ntacls	NT Acls.
Module	param	Parsing and writing Samba configuration files.
Module	policy	(Group) Policy manipulation
Package	provision	Functions for setting up a Samba configuration.
Module	registry	Registry
Package	samba3	Support for reading Samba 3 data files.
Module	samdb	Convenience functions for using the SAM.
Module	schema	Functions for setting up a Samba Schema.
Module	sd_utils	Utility methods for security descriptor manipulation.
Module	security	Security support.
Module	sites	Manipulating sites.
Module	smb	SMB File I/O support
Module	socket	No module docstring; 1/1 functions documented
Module	socket_wrapper	Socket wrapper
Package	tests	Samba Python tests.
Module	upgrade	Support code for upgrading from Samba 3 to Samba 4.
Module	upgradehelpers	Helpers used for upgrading between different database formats.
Package	web_server	Undocumented
Module	xattr	No module docstring; 2/2 functions documented
Module	xattr_native	Python bindings for xattr manipulation.
Module	xattr_tdb	Python bindings for xattr manipulation.
Module	_glue	Python bindings for miscellaneous Samba functions.
Module	_ldb	Samba-specific LDB python bindings

From the __init__.py module:

Class

Ldb

Simple Samba-specific LDB subclass that takes care of setting up the modules dir, credentials pointers, etc.

Function

check_all_substituted

Check that all substitution variables in a string have been replaced.

Function

dn_from_dns_name

return a DN from a DNS name domain/forest root

Function

ensure_external_module

Add a location to sys.path if an external dependency can't be found.

Function

import_bundled_package

Import the bundled version of a package.

Function

in_source_tree

Return True if we are running from within the samba source tree

Function

is_valid_netbios_char

Undocumented

Function

read_and_sub_file

Read a file and sub in variables found in it

Function

setup_file

Setup a file in the private dir.

Function

source_tree_topdir

Return the top level source directory.

Function

substitute_var

Substitute strings of the form ${NAME} in str, replacing with substitutions from values.

Function

valid_netbios_name

Check whether a name is valid as a NetBIOS name.

def source_tree_topdir():

Return the top level source directory.

def in_source_tree():

Return True if we are running from within the samba source tree

def substitute_var(text, values):

Substitute strings of the form ${NAME} in str, replacing with substitutions from values.

Parameters	text	Text in which to subsitute.
	values	Dictionary with keys and values.

def check_all_substituted(text):

Check that all substitution variables in a string have been replaced.

If not, raise an exception.

Parameters text The text to search for substitution variables

def read_and_sub_file(file_name, subst_vars):

Read a file and sub in variables found in it

Parameters file_name File to be read (typically from setup directory) param subst_vars: Optional variables to subsitute in the file.

def setup_file(template, fname, subst_vars=None):

Setup a file in the private dir.

Parameters	template	Path of the template file.
	fname	Path of the file to create.
	subst_vars	Substitution variables.

def is_valid_netbios_char(c):

Undocumented

def valid_netbios_name(name):

Check whether a name is valid as a NetBIOS name.

def import_bundled_package(modulename, location):

Import the bundled version of a package.

Parameters	modulename	Module name to import
	location	Location to add to sys.path (can be relative to ${srcdir}/lib)
Note	This should only be called if the system version of the package is not adequate.

def ensure_external_module(modulename, location):

Add a location to sys.path if an external dependency can't be found.

Parameters	modulename	Module name to import
	location	Location to add to sys.path (can be relative to ${srcdir}/lib)

def dn_from_dns_name(dnsdomain):

return a DN from a DNS name domain/forest root