---
title: "Acquire Server"
---
Acquires a server from a resource pool defined by a server role.
Acquire-Server(
[Role: <text>],
[ServerName: <text>],
[Verbose: <true/false>]
);
This operation may be prefixed with Core::
, although this is a built-in namespace and isn't really necessary.
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 |
# acquires a server associated with the build-servers role
Acquire-Server(
Role: build-servers,
ServerName => $AcquiredServerName
);
for server $AcquiredServerName
{
Log-Information Acquired server: $ServerName;
}