Function overview

The custom server extensions API offers several classes of functions to help you write custom server extensions.

The custom server extensions API consists of a set of Python functions that you can use to run commands and manage processes, perform DNS lookups, and gain access to directories and files on remote targets. The API also provides functions to manipulate media access control (MAC) and IP addresses and use operating system handles to retrieve information.

The API further supplies a set of utility functions that you can use to perform useful tasks within your applications.

The following categories of functions are available in the custom server extensions API.

Capability
Use capabilities like ExecuteCapability, MibQueryCapability, or OsInfoCapability.
Command and process
Run commands on a target as well as manage and display process-related information.
DNS and domains
Perform domain name lookups and validate fully qualified domain names.
File access
List directory contents and capture files from remote targets.
IP and MAC address
Manipulate and convert IP and MAC addresses.
Operating system
Create and use operating system handles to retrieve information.
Path
Convert Windows and Unix path separator characters.
Utility
Initialize the custom server API and perform miscellaneous useful tasks.
Version information
Determine the API version numbers.