/ 
QualysGuard-Request-0.02
River stage zero No dependents
/ QualysGuard::Request

NAME

QualysGuard::Request - Simple interface to QualysGuard API

VERSION

Version 0.01

SYNOPSIS

use QualysGuard::Request;

$QualysGuard::Request::Username = "username";
$QualysGuard::Request::Password = "password";

my $qualys_request = QualysGuard::Request->new( 'map_report_list' );

# - provide map_report_list function arguments

$qualys_request->attributes({
    'last'    => 'yes',
    'domain'  => 'example.com', 
});

# - qualys_response is a QualysGuard::Response::MapReportList object

my $qualys_response = $qualys_request->submit();

if ( $qualys_response->is_error() ) {
    die $qualys_response->get_error(); 
}

# - QualysGuard::Response is a subclass of XML::XPath which allows
# - XML::XPath functionality in each of the QualysGuard::Response subclasses.
# - In short you can extract data using the XML::XPath interface.

my @map_refs = $qualys_response->findnodes('/SOME/XPATH/');

...

DESCRIPTION

Each XML response from the QualysGuard API has an associated doctype definition (DTD). Therefore each DTD has an associated subclass of QualysGuard::Response. Below is a list of the QualysGuard functions supported by QualysGuard::Request.

Qualys Function QualysGuard::Response Subclass
------------------ --------------------------------------
asset_data_report QualysGuard::Response::AssetDataReport
asset_domain QualysGuard::Response::GenericReturn
asset_domain_list QualysGuard::Response::AssetDomainList
asset_group QualysGuard::Response::GenericReturn
asset_group_delete QualysGuard::Response::GenericReturn
asset_group_list QualysGuard::Response::AssetGroupList
asset_ip QualysGuard::Response::GenericReturn
asset_ip_list QualysGuard::Response::AssetHostList
asset_range_info QualysGuard::Response::AssetRangeInfo
asset_search QualysGuard::Response::AssetSearchReport
iscanner_list QualysGuard::Response::IScannerList
map QualysGuard::Response::MapReport
map-2 QualysGuard::Response::MapReport2
map_report QualysGuard::Response::MapReport
map_report_list QualysGuard::Response::MapReportList
report_template_list QualysGuard::Response::ReportTemplateList
scan QualysGuard::Response::ScanReport
scan_cancel QualysGuard::Response::GenericReturn
scan_options QualysGuard::Response::ScanOptions
scan_report QualysGuard::Response::ScanReport
scan_report_delete QualysGuard::Response::GenericReturn
scan_report_list QualysGuard::Response::ScanReportList
scan_running_list QualysGuard::Response::ScanRunningList
scan_target_history QualysGuard::Response::ScanTargetHistory
scheduled_scans QualysGuard::Response::ScheduledScans
ticket_delete QualysGuard::Response::TicketDelete
ticket_edit QualysGuard::Response::TicketEdit
ticket_list QualysGuard::Response::TicketList
ticket_list_deleted QualysGuard::Response::TicketListDeleted

PUBLIC INTERFACE

new ( QUALYS_FUNCTION )

Returns a new QualysGuard::Request object.

attributes ( $QUALYS_FUNCTION_ARGS )

The attributes method takes a single hashref argument. The hashref should contain all of the needed QualysGuard function arguments. Refer to the QualysGuard API documentation for list of arguments for each of the available functions.

http://www.qualys.com/docs/QualysGuard_API_User_Guide.pdf

submit ()

Submits the request and returns a new subclass of QualysGuard::Response.

AUTHOR

Patrick Devlin, <pdevlin at cpan.org>

BUGS

Please report any bugs or feature requests to bug-qualysguard-request at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=QualysGuard::Request. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc QualysGuard::Request

You can also look for information at:

SEE ALSO

QualysGuard::Response

COPYRIGHT & LICENSE

Copyright 2008 Patrick Devlin, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Qualys and the QualysGuard product are registered trademarks of Qualys, Inc.