settings interface — VMware Salt API

settings interface — VMware Salt API

settings interface

The LoadedMod class allows for the module loaded onto the sub to return custom sequencing, for instance it can be iterated over to return all functions

delete_auth_config(config_name: <class 'str'>)

Delete the authentication configuration by the provided name

Parameters

name:The name of the authentication configuration to delete.
delete_sso_config(slug)

Get SSO configuration settings

Parameters

slug:SSO Slug ID.
end_directory_preview(config_name: <class 'str'>, preview_type: <class 'str'> = user, task_id: <class 'str'>)

Clears out the Redis cache entry for this particular preview job. This does not stop the background task, to stop a background Celery task is somewhat ugly, we can revisit this later if it appears we really need to make sure the task is dead.

get_auth_config_access(config_uuid: <class 'uuid.UUID'>)
Returns: <class 'dict'>

Return access metadata for this authentication configuration.

Parameters

config_uuid:UUID referencing desired authentication configuration.
get_auth_config(config_name: str | None, include_preview: bool | None)
Returns: ['dict', 'list']

Return the authentication configuration by the provided name, or all authentication configurations if name is not specified.

Parameters

config_name:Name of the configuration to retrieve. Retrieve all if config_name is None.
include_preview:Include any auth_configs that are marked Preview. Defaults to False. Only matters if config_name is None, if a config_name is passed, always return the config whether it is a preview config or not.
get_config_unprotected(name: <class 'str'>)
Returns: <class 'dict'>

Get info for the login banner

get_directory_preview_records(config_name: <class 'str'>, preview_type: <class 'str'> = user, task_id: str | None, page: <class 'int'>, limit: <class 'int'> = 1000)

Return the records retrieved from the LDAP directory as collected so far. The return payload will contain the LDAP records under the entries key as well as the status of the background job that is querying the directory. The status will appear in the status key of the return payload.

get_directory_preview_status(config_name: <class 'str'>, preview_type: <class 'str'> = user, task_id: str | None)

Return a status for the background LDAP query job.

get_sso_backends(backend)

Get backend field definitions

Parameters

backend:SSO backend ID
get_sso_config(slug)

Get SSO configuration settings

Parameters

slug:SSO Slug ID.
get_telemetry_status()
Returns: <class 'bool'>

Return the status of telemetry collection and reporting to VMware. True means telemetry is being sent to VMware. False means no telemetry data is transmitted.

save_auth_config_access(config_uuid: <class 'uuid.UUID'>, access_payload: <class 'dict'>)

Save access metadata for this authentication configuration.

Parameters

config_uuid:UUID referencing desired authentication configuration.
access_payload:Dictionary containing role names as keys and a list of allowed access types as values
save_auth_config(config_name: <class 'str'>, driver: <class 'str'>, host: <class 'str'>, port: <class 'int'>, bind_dn: <class 'str'>, bind_pw: <class 'str'>, base_dn: <class 'str'>, person_class: <class 'str'>, user_search_base_dn: str | None, user_search_scope: str | None, user_search_filter: str | None, account_attr_name: <class 'str'> = sAMAccountName, user_membership_attr_name: str | None = member, group_class: <class 'str'> = group, group_search_base_dn: str | None, group_search_scope: str | None, group_search_filter: str | None, group_attr_name: <class 'str'> = cn, group_member_attr_name: str | None = member, group_membership_attr_name: str | None = memberOf, group_member_is_dn: bool | None = True, remote_uid_attr_name: str | None, preview_config: <class 'bool'>, auth_bind_dn: str | None, auth_bind_dn_filter: str | None, use_ssl: bool | None, ssl_validate_cert: bool | None = True, display_name: str | None, sync_schedule: int | None = 60, config_uuid: uuid.UUID | None, skip_job_scheduling: <class 'bool'>)

Create or update the authentication configuration by the provided config_name.

Parameters

config_name:Name of the auth configuration
**:Dictionary with details defining this authentication configuration.
skip_job_scheduling:If False, no scheduler jobs which maintain synchronization with the Active Directory/LDAP backend are created.
save_sso_config(name, backend, config)

Save SSO configuration settings

Parameters

name:Name of the SSO.
backend:SSO backend.
config:Configuration settings.
set_telemetry_status(flag: <class 'bool'>)

Set the status of telemetry permission. This API is should be called by LCM with the value of the CEIP opt-in checkbox, or in the SaaS deployments with the value of the SUDP checkbox whenever the customer changes it.

start_directory_preview(config_name: <class 'str'>, preview_type: <class 'str'> = user, custom_directory_filter: str | None, max_entries: int | None, include_raas_links: <class 'bool'>, search_term: <class 'str'>)

Execute a background task that will return a set of example records from the defined LDAP or Active Directory. Returns a task_id that can be used to check on the status of the preview. LDAP records are cached in Redis and can be retrieved with get_directory_preview_records().

sync_auth_config(config_name: <class 'str'>)
Returns: <class 'list'>

Get updated information from the LDAP backend on users currently in use in SSE.

Parameters

config_name:Name of the configuration to synchronize.
test_auth_config(config_name: <class 'str'>, driver: <class 'str'>, host: <class 'str'>, port: <class 'int'>, bind_dn: <class 'str'>, bind_pw: <class 'str'>, base_dn: <class 'str'>, person_class: <class 'str'>, account_attr_name: <class 'str'>, group_class: <class 'str'>, group_attr_name: <class 'str'>, remote_uid_attr_name: <class 'str'>, preview_config: <class 'bool'>, auth_bind_dn: str | None, auth_bind_dn_filter: str | None, use_ssl: bool | None, ssl_validate_cert: bool | None = True, display_name: str | None, sync_schedule: int | None = 60)
Returns: <class 'dict'>

Test Active Directory/LDAP connectability and credentials for the provided authentication configuration details

Parameters

details:Connection details for the AD/LDAP backend.

Returns a dictionary with at least one key, validation_passed, for which the value is True or False depending on the outcome of the validation routines. If validation failed, an extra key, details is also included with an explanation on what failed..