new({login,password,host,[port]})
LogOut()
ProjectList()
AuthList()
CollectorList()
SelectorList()
ServerList()
ScheduleList()
ClassList()
EnvList()
AccessList()
GroupList()
(deprecated)UserList()
AdaptorList()
GetLastError()
LogOut()
BuildForge::API
lib::BuildForge::API lib::BuildForge::NameMap lib::BuildForge::Connection::Encoded lib::BuildForge::API::Access lib::BuildForge::API::Adaptor lib::BuildForge::API::Build lib::BuildForge::API::Class lib::BuildForge::API::Environ lib::BuildForge::API::Group lib::BuildForge::API::Interface lib::BuildForge::API::Project lib::BuildForge::API::Register lib::BuildForge::API::Schedule lib::BuildForge::API::Server lib::BuildForge::API::Step lib::BuildForge::API::TagVar BuildForge::API::User
use BuildForge::API my $API = new BuildForge::API({ login=>"root", password=>"root", host=>"bfhost.company.com", port=>80, base=>"/api/api.php"});
Creates a connection to the BuildForge API to allow interaction with the console. It is recommended that only one API object exist in your code.
new({login,password,host,[port]})
Creates a new connection to the BuildForge API.
LogOut()
Logs the current API session out of the BuildForge console.
ProjectList()
Returns an array ref of hash refs containing basic Project information (Project ID, Project Title, and Access Level).
AuthList()
Returns an array ref of hash refs containing names that can be used for server authentication authids. (Auth Id).
CollectorList()
Returns an array ref of hash refs containing names that can be used to gather server configurations. (Collector Id).
SelectorList()
Returns an array ref of hash refs containing names that can be used by Projects and Steps to select a server configuration. (Selector Id).
ServerList()
Returns an array ref of hash refs containing basic Server information (Server Name, Server Host, and Access Level).
ScheduleList()
Returns an array ref of hash refs containing Schedule Information.
ClassList()
Returns an array ref of hash refs containing Class Information.
EnvList()
Returns an array ref of hash refs containing Environment Group Information.
AccessList()
Returns an array ref of hash refs containing Access Group Information.
GroupList()
(deprecated)Returns | an array ref of hash refs containing Access Group Information. This |
method is deprecated; use AccessList() instead. |
UserList()
Returns an array ref of hash refs containing User Information.
AdaptorList()
Returns an array ref of hash refs containing Adaptor Information.
GetLastError()
Returns a scalar value identifying the last error code encountered by the API object.
LogOut()
Logs out the current session.
BuildForge, Inc.