AdminUtilities

The AdminUtilities script library provides the script procedures that administer utilities settings.

The AdminUtilities script library provides the following script procedures. To display detailed information about each script procedures, use the help command for the AdminUtilities script library, specifying the name of the script of interest as an argument.

AdminUtilities.configureAutoSave(*args)

Configure the configuration automation save.

AdminUtilities.convertToList(*args)

Convert string to list.

AdminUtilities.debugNotice(*args)

Set debug notice.

AdminUtilities.fail(msg)

Prints a failure message.

PARAMETER	DESCRIPTION
msg	The message to print. TYPE: str

Example

>>> AdminUtilities.fail("TEST")

FAILURE: 'TEST'

AdminUtilities.fileSearch(*args)

Recrusive file search.

AdminUtilities.getExceptionText(type, value, tb)

Get exception text.

PARAMETER	DESCRIPTION
type	description TYPE: _type_
value	description TYPE: _type_
tb	description TYPE: _type_

RETURNS	DESCRIPTION
message	Exception message with exception type, exception value or traceback information TYPE: str

Example

>>> AdminUtilities.getExceptionText(typ, value, tb)

AdminUtilities.getResourceBundle(*args)

Get resource bundle.

AdminUtilities.getScriptLibraryFiles(*args)

Get the script library files.

AdminUtilities.getScriptLibraryList(*args)

Get the script library names of list.

AdminUtilities.getScriptLibraryPath(*args)

Get the script library path.

AdminUtilities.help(function='')

Provide online help.

Receive help information for the specified AdminUtilities library function or provide help information on all of the AdminUtilities script library function if parameters are not passed.

AdminUtilities.infoNotice(*args)

Set information notice.

AdminUtilities.save(*args)

Save all configuration change.

AdminUtilities.setDebugNotices(*args)

Set debug notice.

AdminUtilities.setFailOnErrorDefault(*args)

Set failonerror default.

AdminUtilities.sleepDelay(secs)

Set sleep delay.

AdminUtilities.warningNotice(*args)

Set warning notice.