App::Netdisco::JobQueue
Interface for Netdisco job queue.
There are no default exports, however the :all tag will export all subroutines.
:all
Returns a list of randomly selected queued jobs. Default is to return one job, unless $num is provided. Jobs are returned as objects which implement the Netdisco job instance interface (see below).
$num
Same as jq_getsome but for high priority jobs.
jq_getsome
Returns the list of jobs currently booked out to this processing node (denoted by the local hostname). Jobs are returned as objects which implement the Netdisco job instance interface (see below).
Returns a list of IP addresses of devices which currently have a job of the given $job_type queued (e.g. discover, arpnip, etc).
$job_type
discover
arpnip
Sets up a table of hints for the backend daemon manager to help avoid picking jobs from the queue that it cannot process due to *_no configuration settings.
*_no
Returns a list of the most recent 50 jobs in the queue. Jobs are returned as objects which implement the Netdisco job instance interface (see below).
Returns a list of jobs which have been entered into the queue by the passed $user. Jobs are returned as objects which implement the Netdisco job instance interface (see below).
$user
Marks a job in the queue as booked out to this processing node (denoted by the local hostname). The $job parameter must be an object which implements the Netdisco job instance interface (see below).
$job
Returns true if successful else returns false.
Marks a job in the queue as available for taking. This is usually done after a job is booked but the processing node changes its mind and decides to return the job to the queue. The $job parameter must be an object which implements the Netdisco job instance interface (see below).
Marks a job as complete. The $job parameter must be an object which implements the Netdisco job instance interface (see below). The queue item's status, log and finished fields will be updated from the passed $job.
Adds the passed jobs to the queue.
If passed the ID of a job, deletes it from the queue. Otherwise deletes ALL jobs from the queue.
To install App::Netdisco, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::Netdisco
CPAN shell
perl -MCPAN -e shell install App::Netdisco
For more information on module installation, please visit the detailed CPAN module installation guide.