Note
This plugin is part of the netapp.ontap collection (version 21.12.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install netapp.ontap.
To use it in a playbook, specify: netapp.ontap.na_ontap_job_schedule.
New in version 2.6.0: of netapp.ontap
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| cert_filepath string added in 20.6.0 of netapp.ontap | path to SSL client cert file (.pem). not supported with python 2.6. | |
| feature_flags dictionary added in 20.5.0 of netapp.ontap | Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. | |
| hostname string / required | The hostname or IP address of the ONTAP instance. | |
| http_port integer | Override the default port (80 or 443) with this port | |
| https boolean |
| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. |
| job_days_of_month list / elements=integer added in 2.8.0 of netapp.ontap | The day(s) of the month when the job should be run. Job Manager cron scheduling day of month. -1 represents all days of a month from 1 to 31. Range is [-1..31] | |
| job_days_of_week list / elements=integer added in 2.8.0 of netapp.ontap | The day(s) in the week when the job should be run. Job Manager cron scheduling day of week. Zero represents Sunday. -1 represents all days of a week. Range is [-1..6] | |
| job_hours list / elements=integer added in 2.8.0 of netapp.ontap | The hour(s) of the day when the job should be run. Job Manager cron scheduling hour. -1 represents all hours. Range is [-1..23] | |
| job_minutes list / elements=integer | The minute(s) of each hour when the job should be run. Job Manager cron scheduling minute. -1 represents all minutes. Range is [-1..59] Required for create. | |
| job_months list / elements=integer added in 2.8.0 of netapp.ontap | The month(s) when the job should be run. Job Manager cron scheduling month. -1 represents all months. Range is [-1..12], 0 and 12 may or may not be supported, see month_offset
| |
| key_filepath string added in 20.6.0 of netapp.ontap | path to SSL client key file. | |
| month_offset integer added in 21.9.0 of netapp.ontap |
| whether January starts at 0 or 1. By default, ZAPI is using a 0..11 range, while REST is using 1..12. default to 0 when using ZAPI, and to 1 when using REST. when set to 0, a value of 12 or higher is rejected. when set to 1, a value of 0 or of 13 or higher is rejected. |
| name string / required | The name of the job-schedule to manage. | |
| ontapi integer | The ontap api version to use | |
| password string | Password for the specified user. aliases: pass | |
| state string |
| Whether the specified job schedule should exist or not. |
| use_rest string | Default: "auto" | REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api |
| username string | This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required. For more information, please read the documentation https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. aliases: user | |
| validate_certs boolean |
| If set to no, the SSL certificates will not be validated.This should only set to False used on personally controlled sites using self-signed certificates. |
Note
- name: Create Job for 11.30PM at 10th of every month
netapp.ontap.na_ontap_job_schedule:
state: present
name: jobName
job_minutes: 30
job_hours: 23
job_days_of_month: 10
job_months: -1
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Create Job for 11.30PM at 10th of January, April, July, October for ZAPI and REST
netapp.ontap.na_ontap_job_schedule:
state: present
name: jobName
job_minutes: 30
job_hours: 23
job_days_of_month: 10
job_months: 1,4,7,10
month_offset: 1
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Create Job for 11.30PM at 10th of January, April, July, October for ZAPI and REST
netapp.ontap.na_ontap_job_schedule:
state: present
name: jobName
job_minutes: 30
job_hours: 23
job_days_of_month: 10
job_months: 0,3,6,9
month_offset: 0
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Create Job for 11.30PM at 10th of January when using REST and February when using ZAPI !!!
netapp.ontap.na_ontap_job_schedule:
state: present
name: jobName
job_minutes: 30
job_hours: 23
job_days_of_month: 10
job_months: 1
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
- name: Delete Job
netapp.ontap.na_ontap_job_schedule:
state: absent
name: jobName
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_job_schedule_module.html