NAME

BuildForge::API::Server


SYNOPSIS

        my $Server = new BuildForge::API::Server();
        $Server->{'name'} = "My Build Server";
        $Server->{'hostname'} = "build.buildforge.com";
        $Server->{'authid'} = "MyAuthId";
        $Server->{'collector'} = "MyCollector";
        $Server->Create();


DESCRIPTION

    This is available to use after a BuildForge::API object has been
instantiated. It is used to create new BuildForge servers, and to access
existing server definitions.


METHODS

new({ServerParamsHashRef})

Create an object to access existing server information or to add a new server to the BuildForge console.

name
The name for the server

hostname
The host or address for the server

access_group_id
ID of the access level for this server

root_path
The root directory for this servers step activity

load_percent
Load balancing number (1 to 100)

transfer_mode
Allowed file access (``none'',``put'',``get'',``all'')

environment_id
ID of the environment group to use (integer)

authid
The Authentication combo-name to use with this server to log onto the host

collector
The collector name that identifies what information to gather about this server to use for steps server selection

Create()

Create a new BuildForge Server. Requires server 'name', and 'hostname', 'authid', and 'collector' to be set.

Delete()

Deletes the server. Requires the server 'name' to be set.

Enable()

Enables the server. Requires the server 'name' to be set.

Disable()

Disables the server. Requires the server 'name' to be set.

IncrementJobCount()

Increases the Job count for a server. Requires the server 'name' to be set.

DecrementJobCount()

Decreases the Job count for a server - does not decrease below 0. Requires the server 'name' to be set.

Manifest()

Returns a hash-ref containing name/value pairs that are in the servers current manifest.

Sync()

Syncs the server object with information from the console database. Requires the server 'name' to be set.


AUTHOR

BuildForge, Inc.