# # Copyright 2022 Centreon (http://www.centreon.com/) # # Centreon is a full-fledged industry-strength solution that meets # the needs in IT infrastructure and application monitoring for # service performance. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # package apps::automation::ansible::tower::mode::jobtemplates; use base qw(centreon::plugins::templates::counter); use strict; use warnings; use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold_ng); sub prefix_output_global { my ($self, %options) = @_; return 'Job templates '; } sub prefix_output_jobtpl { my ($self, %options) = @_; return "Job template '" . $options{instance_value}->{display} . "' "; } sub set_counters { my ($self, %options) = @_; $self->{maps_counters_type} = [ { name => 'global', type => 0, cb_prefix_output => 'prefix_output_global' }, { name => 'jobtpl', type => 1, cb_prefix_output => 'prefix_output_jobtpl', message_multiple => 'All job templates are ok', skipped_code => { -10 => 1 } } ]; $self->{maps_counters}->{global} = [ { label => 'total', nlabel => 'jobtemplates.total.count', set => { key_values => [ { name => 'total' } ], output_template => 'total: %d', perfdatas => [ { value => 'total', template => '%d', min => 0 } ] } } ]; foreach ((['successful', 1], ['failed', 1], ['running', 1], ['canceled', 0], ['pending', 0], ['default', 0], ['never', 0])) { push @{$self->{maps_counters}->{global}}, { label => $_->[0], nlabel => 'jobtemplates.' . $_->[0] . '.count', display_ok => $_->[1], set => { key_values => [ { name => $_->[0] }, { name => 'total' } ], output_template => $_->[0] . ': %d', perfdatas => [ { template => '%d', min => 0, max => 'total' } ] } }; } $self->{maps_counters}->{jobtpl} = [ { label => 'job-status', type => 2, unknown_default => '%{last_job_status} =~ /default/', critical_default => '%{last_job_status} =~ /failed/', set => { key_values => [ { name => 'last_job_status' }, { name => 'display' } ], output_template => "last job status is '%s'", closure_custom_perfdata => sub { return 0; }, closure_custom_threshold_check => \&catalog_status_threshold_ng } } ]; } sub new { my ($class, %options) = @_; my $self = $class->SUPER::new(package => __PACKAGE__, %options, force_new_perfdata => 1); bless $self, $class; $options{options}->add_options(arguments => { 'filter-name:s' => { name => 'filter_name' }, 'launch-job-template-id:s' => { name => 'launch_job_template_id' }, 'launch-extra-vars:s' => { name => 'launch_extra_vars' }, 'launch-tags:s' => { name => 'launch_tags' }, 'launch-limit:s' => { name => 'launch_limit' }, 'launch-inventory:s' => { name => 'launch_inventory' }, 'launch-credential:s' => { name => 'launch_credential' }, 'launch-max-retries:s' => { name => 'launch_max_retries', default => 5 }, 'launch-retry-interval:s' => { name => 'launch_retry_interval', default => 10 } }); return $self; } sub launch_job { my ($self, %options) = @_; my $job = $options{custom}->tower_launch_job_template( launch_job_template_id => $self->{option_results}->{launch_job_template_id}, launch_extra_vars => $self->{option_results}->{launch_extra_vars}, launch_tags => $self->{option_results}->{launch_tags}, launch_limit => $self->{option_results}->{launch_limit}, launch_inventory => $self->{option_results}->{launch_inventory}, launch_credential => $self->{option_results}->{launch_credential} ); my $job_id = $job->{id}; my ($job_completed, $retry_idx, $job_result); $retry_idx = 0; while (!defined($job_completed) && $retry_idx < $self->{option_results}->{launch_max_retries}) { sleep($self->{option_results}->{launch_retry_interval}) if ($retry_idx > 0); $job_result = $options{custom}->tower_get_job(job_id => $job_id); $job_completed = $job_result->{finished}; $retry_idx++; } if ($retry_idx >= $self->{option_results}->{launch_max_retries}) { $self->{output}->add_option_msg(short_msg => 'cannot get the last job result'); $self->{output}->option_exit(); } $job->{summary_fields}->{last_job} = $job_result; return [$job]; } sub manage_selection { my ($self, %options) = @_; my $jobs; if (defined($self->{option_results}->{launch_job_template_id}) && $self->{option_results}->{launch_job_template_id} =~ /\d+/) { $jobs = $self->launch_job(custom => $options{custom}); } else { $jobs = $options{custom}->tower_list_job_templates(); } $self->{global} = { total => 0, failed => 0, successful => 0, canceled => 0, default => 0, pending => 0, running => 0, never => 0 }; $self->{jobtpl} = {}; foreach my $job (@$jobs) { next if (defined($self->{option_results}->{filter_name}) && $self->{option_results}->{filter_name} ne '' && $job->{name} !~ /$self->{option_results}->{filter_name}/); $self->{jobtpl}->{ $job->{id} } = { display => $job->{name}, last_job_status => defined($job->{summary_fields}->{last_job}->{status}) ? $job->{summary_fields}->{last_job}->{status} : 'never' }; $self->{global}->{total}++; if (defined($job->{summary_fields}->{last_job}->{status})) { $self->{global}->{ $job->{summary_fields}->{last_job}->{status} }++; } else { $self->{global}->{never}++; } } } 1; __END__ =head1 MODE Check job templates. =over 8 =item B<--filter-name> Filter job template name (Can use regexp). =item B<--launch-job-template-id> The job_template id to launch. =item B<--launch-inventory> Specify inventory for job template to run. =item B<--launch-credential> Specify machine credential for job template to run. =item B<--launch-tags> Specify tagged actions in the playbook to run. =item B<--launch-limit> Specify host limit for job template to run. =item B<--launch-extra-vars> yaml format text that contains extra variables to pass on. =item B<--launch-max-retries> Number of retries to get job result once launched (Default: 5). =item B<--launch-retry-interval> Number of seconds between retries (Default : 10). =item B<--unknown-job-status> Set unknown threshold for status (Default: '%{last_job_status} =~ /default/'). Can used special variables like: %{last_job_status}, %{display} =item B<--warning-job-status> Set warning threshold for status. Can used special variables like: %{last_job_status}, %{display} =item B<--critical-job-status> Set critical threshold for status (Default: '%{last_job_status} =~ /failed/'). Can used special variables like: %{last_job_status}, %{display} =item B<--warning-*> B<--critical-*> Thresholds. Can be: 'total', 'successful', 'failed', 'running', 'canceled', 'pending', 'default', 'never'. =back =cut