BuildMaster Documentation

Servers - Restart Server

  • Last Modified: 2020-06-26

This is generated from the built-in components of BuildMaster 6.2.13, and may be different than what you have installed (especially if you have extensions); go to [User Icon] > Documentation within your BuildMaster instance to see exactly what operations are available.

Restart Server

Restarts a server and waits for it to become available again.

Script usage:

Restart-Server(
	[After: <integer>],
	[MinimumDelay: <integer>]
);

This operation may be prefixed with BuildMaster::, although this is a built-in namespace and isn't really necessary.

Arguments:

Name Format Script Usage Usage Notes
Restart after
integer
After
Minimum reconnect wait
integer
MinimumDelay

Note: The After and MinimumDelay properties are advanced options, and determine how many seconds to wait before the operating system shutdown is initiated (default and minimum value is 5), and how many seconds to wait until attempting to reconnect to the agent (default and minimum value is 15). These generally should be kept at defaults, unless the server takes an extraordinary time to shutdown.

Note: If the server is used by another operation before this operation completes, then the results are undefined.

Example:

    # restart the current server after 10 seconds
    Restart-Server(
        After: 10
    );

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit ced119d5 on master