NAME

BuildForge::API::Collector


SYNOPSIS

        my $Collector = new BuildForge::API::Collector({'name'=>"Yours",'properties'=>[{'property'=>"MEM_TOTAL"}]});
        $Collector->Sync();
        $Collector->AddProperty({
                'property'=>"WIN_SERVICEPACK"
        });
        $Collector->DeleteProperty({
                'property'=>"WIN_SERVICEPACK"
        });


DESCRIPTION

Allows you to create and modify collectors for use with servers.


METHODS

new({CollectorParamsHashRef})

Creates the collector object to create and modify collector data for use with the BuildForge console.

name
The name for this collector.

properties
A set of properties to use for this collector.

Sync()

Syncs the object with the current console data for the collector.

BuiltInProperties()

Returns a list reference of Built-in auto-populated properties that are available for use in collectors.

AddProperty(PropertyParamsHashref)

Adds a property to the collector.

property
The name of this property

value
The value to assign to this property

userproperty
If this is a property that has to have a command run ('Y').

regex
The regular expression to use to parse the output of the value command to populate the actual value in the corresponding servers manifest.

DeleteProperty(PropertyParamsHashref)

Deletes a property from this collector

property
The name of the property to delete

Create()

Creates a new collector for use by servers.

Delete()

Deletes the collector from the buildforge console. Note that no servers should be using the collector prior to calling the delete.


AUTHOR

BuildForge, Inc.