ansible.builtin.na_ontap_job_schedule (v2.9.26) — module

NetApp ONTAP Job Schedule

| "added in version" 2.6 of ansible.builtin"

Authors: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>

preview | supported by certified

Install Ansible via pip

Install with pip install ansible==2.9.26

Description

Create/Delete/Modify job-schedules on ONTAP


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - 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 }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - name: Delete Job
      na_ontap_job_schedule:
        state: absent
        name: jobName
        hostname: "{{ netapp_hostname }}"
        username: "{{ netapp_username }}"
        password: "{{ netapp_password }}"

Inputs

    
name:
    description:
    - The name of the job-schedule to manage.
    required: true

https:
    default: false
    description:
    - Enable and disable https.
    - Ignored when using REST as only https is supported.
    - Ignored when using SSL certificate authentication as it requires SSL.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the specified job schedule should exist or not.

ontapi:
    description:
    - The ontap api version to use
    type: int

hostname:
    description:
    - The hostname or IP address of the ONTAP instance.
    required: true
    type: str

password:
    aliases:
    - pass
    description:
    - Password for the specified user.
    type: str

use_rest:
    choices:
    - Never
    - Always
    - Auto
    default: Auto
    description:
    - 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
    type: str

username:
    aliases:
    - user
    description:
    - 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 U(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.
    type: str

http_port:
    description:
    - Override the default port (80 or 443) with this port
    type: int

job_hours:
    description:
    - 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]
    type: list
    version_added: '2.8'
    version_added_collection: ansible.builtin

job_months:
    description:
    - 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]
    type: list
    version_added: '2.8'
    version_added_collection: ansible.builtin

job_minutes:
    description:
    - 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]
    type: list

key_filepath:
    description:
    - path to SSL client key file.
    type: str
    version_added: 20.6.0
    version_added_collection: netapp.ontap

cert_filepath:
    description:
    - path to SSL client cert file (.pem).
    - not supported with python 2.6.
    type: str
    version_added: 20.6.0
    version_added_collection: netapp.ontap

feature_flags:
    description:
    - 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.
    type: dict
    version_added: 20.5.0
    version_added_collection: netapp.ontap

validate_certs:
    default: true
    description:
    - If set to C(no), the SSL certificates will not be validated.
    - This should only set to C(False) used on personally controlled sites using self-signed
      certificates.
    type: bool

job_days_of_week:
    description:
    - 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]
    type: list
    version_added: '2.8'
    version_added_collection: ansible.builtin

job_days_of_month:
    description:
    - 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]
    type: list
    version_added: '2.8'
    version_added_collection: ansible.builtin