cterasdk.edge.directoryservice module#
- class cterasdk.edge.directoryservice.DirectoryService(edge)#
Bases:
BaseCommandEdge Filer Active Directory configuration APIs
- connect(domain, username, password, ou=None, check_connection=False)#
Connect the Edge Filer to an Active Directory
- Parameters:
domain (str) – The active directory domain to connect to
username (str) – The user name to use when connecting to the active directory services
password (str) – The password to use when connecting to the active directory services
ou (str,optional) – The OU path to use when connecting to the active directory services, defaults to None
check_connection (bool,optional) – Check connectivity before attempting to connect to directory services, defaults to False
- connected()#
Get the Active Directory join status
- disconnect()#
Disconnect from Active Directory Service
- domains()#
Get all domains
- Return list(str):
List of names of all discovered domains
- get_advanced_mapping()#
Retrieve directory services advanced mapping configuration
- Returns:
A dictionary of domain mapping objects
- Return type:
dict
- get_connected_domain()#
Get the connected domain information
- Return cterasdk.common.object.Object:
- get_static_domain_controller()#
Retrieve the static domain controller configuration
- Returns:
A FQDN, hostname or ip address of the domain controller
- Return type:
str
- remove_static_domain_controller()#
Delete the static domain controller configuration
- set_advanced_mapping(mappings)#
Configure advanced mapping
- Parameters:
mappings (list[cterasdk.common.types.ADDomainIDMapping]) – List of domains and their UID/GID mapping range
- set_static_domain_controller(dc)#
Configure the Edge Filer to use a static domain controller
- Parameters:
dc (str) – The FQDN, hostname or ip address of the domain controller
- Returns:
The FQDN, hostname or ip address of the domain controller
- Return type:
str