|
|
function ov transport disconnect in split format
|
|
= NAME =
ov_transport_disconnect
|
|
|
= SYNOPSIS =
* ov_transport_disconnect
|
|
|
= DESCRIPTION =
ov_transport_disconnect is an internal function used to release a connection
to the target. It is called during the "post_test" phase (during cleanup) in order to
do any required operations to release the connection with the board.
|
|
It uses the $TRANPORT variable to select the correct method to use
to disconnect.
|
It uses the $TRANPORT variable to select the correct method to use
to disconnect.
|
|
As with other "ov_" functions, it can be overridden in the board file for a board, to customize any operations required for disconnecting from a board.
|
As with other "ov_" functions, it can be overridden in the board file for a board, to customize any operations required for disconnecting from a board.
|
|
This could be used for a number of things, including:
|
This could be used for a number of things, including:
|
- powering off a board
* relinquishing a VPN connection to a remote lab
* releasing a board reservation using an external board management system
|
* powering off a board
* relinquishing a VPN connection to a remote lab
* releasing a board reservation using an external board management system
|
|
|
= EXAMPLES =
none
|
|
|
= ENVIRONMENT and ARGUMENTS =
* $TRANSPORT - specifies the type of transport used to communicate with the board. This should be one of "ssh", "serial", "ttc".
|
|
|
= RETURN =
Returns non-zero on error
|
|
|
= SOURCE =
Located in ''overlays/base/base-board.fuegoclass''
|
|
cleanup, ov_transport_connect
|
= SEE ALSO =
* [[function_cleanup|cleanup]], [[function_ov_transport_connect|ov_transport_connect]]
|
|
|