LinuxCommandLibrary

sfdk-engine

Analyze software composition for security vulnerabilities

TLDR

Start the build engine

$ sfdk engine start
copy

Stop the build engine
$ sfdk engine stop
copy

Show the build engine status
$ sfdk engine status
copy

Set an engine property
$ sfdk engine set [property]=[value]
copy

Show the engine properties
$ sfdk engine show
copy

Execute a command on the build engine
$ sfdk engine exec [command]
copy

Start an interactive shell on the build engine
$ sfdk engine exec
copy

SYNOPSIS

sfdk-engine [options]

PARAMETERS

--help
    Display help information.

--version
    Display version information.

--config
    Specify a configuration file.

--discover
    Initiate fabric discovery.

--validate
    Validate the fabric configuration.

--configure
    Apply configurations to the fabric.

--loglevel
    Set the log level (e.g., DEBUG, INFO, WARNING, ERROR).

DESCRIPTION

The `sfdk-engine` command is a core component of the SmartFabric Discovery Kit (SFDK). It serves as the central engine for discovering, validating, and configuring network fabrics.
Specifically, the `sfdk-engine` automates tasks such as device discovery using protocols like LLDP and CDP, fabric validation to ensure correct configuration and connectivity, and switch configuration deployment. It supports various network operating systems and vendors, simplifying fabric management.
The Engine's functionalities often encompass collecting switch configuration data, performing automated tests to identify potential network issues, and applying predefined or user-defined configurations. It streamlines fabric deployment and maintenance through automated discovery and configuration, thus reducing manual intervention and ensuring consistent configuration across the network fabric.

CAVEATS

The specific options and functionality available may vary depending on the version of the SFDK and the specific network operating systems supported.

CONFIGURATION FILES

The configuration file specifies the devices, network parameters, and configuration policies. Ensure the format follows the expected structure of SFDK. Example formats could be XML or YAML.

ERROR HANDLING

SFDK handles errors during discovery, validation, or configuration deployment by logging detailed error messages. Refer to the logs to understand the cause of any problems and take corrective action.

HISTORY

The `sfdk-engine` was developed as part of the SmartFabric Discovery Kit (SFDK) to address the growing complexity of managing modern network fabrics. It originated from the need to automate fabric discovery, validation, and configuration processes, reducing manual effort and ensuring consistency.
Initial versions focused on basic device discovery and validation, while subsequent releases added support for more network vendors and enhanced configuration deployment capabilities. As network technologies evolved, `sfdk-engine` was improved to accommodate new protocols and features, solidifying its position as a key tool for fabric management.

SEE ALSO

lldp(8), cdp(1)

Copied to clipboard