netapp.ontap.na_ontap_job_schedule – NetApp ONTAP Job Schedule

Note

This plugin is part of the netapp.ontap collection (version 21.1.1).

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

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

Create/Delete/Modify job-schedules on ONTAP

Requirements

The below requirements are needed on the host that executes this module.

Ansible 2.9
Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.
A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward.
REST support requires ONTAP 9.6 or later.
To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Parameters

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	no ← yes	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=string 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, and is only supported for cron schedule create and modify. Range is [-1..31]
job_days_of_week list / elements=string 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 and is only supported for cron schedule create and modify. Range is [-1..6]
job_hours list / elements=string 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 and is only supported for cron schedule create and modify. Range is [-1..23]
job_minutes list / elements=string		The minute(s) of each hour when the job should be run. Job Manager cron scheduling minute. -1 represents all minutes and is only supported for cron schedule create and modify. Range is [-1..59]
job_months list / elements=string 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 and is only supported for cron schedule create and modify. Range is [-1..11]
key_filepath string added in 20.6.0 of netapp.ontap		path to SSL client key file.
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	present ← absent	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	no yes ←	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.

Notes

Note

The modules prefixed with na\_ontap are built to support the ONTAP storage platform.

Examples

- name: Create Job for 11.30PM at 10th of every month
  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
  na_ontap_job_schedule:
    state: absent
    name: jobName
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Authors

NetApp Ansible Team (@carchi8py) <[email protected]>

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/netapp/ontap/na_ontap_job_schedule_module.html