BuildMaster Documentation

Servers - Acquire 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.

Acquire Server

Acquires a server from a resource pool defined by a server role. This operation is affected by execution priority.

Script usage:

Acquire-Server(
	[Role: <text>],
	[ServerName: <text>],
	[Verbose: <true/false>],
	[DoNotShare: <true/false>]
);

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

Arguments:

Name Format Script Usage Usage Notes
Server role
text
Role
A server role that defines the list of servers to be used as the source of the pool.
Server name output
text
ServerName
Log verbose
true/false
Verbose
Do not share
true/false
DoNotShare
Do not share this server between multiple AcquireServerOperation uses in this execution. This means that you must call Release Server in order to acquire the same server before the execution finishes.

Example:

# acquires a server associated with the build-servers role
Acquire-Server( 
   Role: build-servers,
   ServerName => $AcquiredServerName
);

for server $AcquiredServerName
{
    Log-Information Acquired server: $ServerName;
}

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