netapp.ontap.na_ontap_job_schedule 模块 – NetApp ONTAP 作业调度

注意

此模块是 netapp.ontap 集合 (版本 22.13.0) 的一部分。

如果您使用的是 ansible 包,则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install netapp.ontap。您需要进一步的要求才能使用此模块,有关详细信息,请参见 需求

要在 playbook 中使用它,请指定:netapp.ontap.na_ontap_job_schedule

netapp.ontap 2.6.0 中新增

概要

  • 在 ONTAP 上创建/删除/修改作业调度

需求

执行此模块的主机需要以下需求。

  • Ansible 2.9 或更高版本 - 建议使用 2.12 或更高版本。

  • Python3 - 建议使用 3.9 或更高版本。

  • 使用 ZAPI 时,需要 netapp-lib 2018.11.13 或更高版本(使用“pip install netapp-lib”安装),强烈建议使用 netapp-lib 2020.3.12,因为它提供了更好的连接问题错误报告。

  • 物理或虚拟集群式 Data ONTAP 系统,模块支持 Data ONTAP 9.1 及更高版本,REST 支持需要 ONTAP 9.6 或更高版本。

参数

参数

注释

cert_filepath

字符串

netapp.ontap 20.6.0 中新增

SSL 客户端证书文件(.pem)的路径。

python 2.6 不支持。

cluster

字符串

netapp.ontap 21.22.0 中新增

默认为本地集群。

在 MetroCluster 配置中,本地集群拥有的用户创建的调度将复制到合作伙伴集群。同样,合作伙伴集群拥有的用户创建的调度将复制到本地集群。

通常,只有本地集群拥有的调度才能在本地集群上创建、修改和删除。但是,当 MetroCluster 配置处于切换状态时,处于切换状态的集群可以创建、修改和删除合作伙伴集群拥有的调度。

feature_flags

字典

netapp.ontap 20.5.0 中新增

启用或禁用新功能。

这可以用于启用实验性功能或禁用破坏向后兼容性的新功能。

支持的键和值可能会更改,恕不另行通知。未知键将被忽略。

force_ontap_version

字符串

netapp.ontap 21.23.0 中新增

使用 REST 时覆盖集群 ONTAP 版本。

如果版本与目标集群不匹配,则行为未定义。

这是在由于权限问题无法读取集群版本时提供的解决方法。参见 https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues

这应采用 9.10 或 9.10.1 的形式,每个元素都是一个整数。

use_rest 设置为 auto 时,这可能会根据版本和平台功能强制切换到 ZAPI。

ZAPI 中忽略。

hostname

字符串 / 必需

ONTAP 实例的主机名或 IP 地址。

http_port

整数

使用此端口覆盖默认端口(80 或 443)

https

布尔值

启用和禁用 https。

使用 REST 时忽略,因为只支持 https。

使用 SSL 证书认证时忽略,因为它需要 SSL。

选项

  • false ← (默认)

  • true

job_days_of_month

列表 / 元素=整数

netapp.ontap 2.8.0 中新增

应该运行作业的月份日期。作业管理器 cron 调度月份日期。

1 代表一个月中的所有日期,从 1 到 31。范围是 [-1..31]

job_days_of_week

列表 / 元素=整数

netapp.ontap 2.8.0 中新增

应该运行作业的一周中的日期。作业管理器 cron 调度星期几。

零代表星期日。-1 代表一周中的所有日期。范围是 [-1..6]

job_hours

列表 / 元素=整数

netapp.ontap 2.8.0 中新增

应该运行作业的一天中的小时数。作业管理器 cron 调度小时。

1 代表所有小时。范围是 [-1..23]

job_minutes

列表 / 元素=整数

应该运行作业的每一小时的分钟数。作业管理器 cron 调度分钟。

1 代表所有分钟。范围是 [-1..59]

创建时必需。

job_months

列表 / 元素=整数

netapp.ontap 2.8.0 中新增

应该运行作业的月份。作业管理器 cron 调度月份。

1 代表所有月份。范围是 [-1..12],0 和 12 可能支持也可能不支持,请参见 month_offset

key_filepath

字符串

netapp.ontap 20.6.0 中新增

SSL 客户端密钥文件的路径。

month_offset

整数

netapp.ontap 21.9.0 中新增

一月是从 0 开始还是从 1 开始。默认情况下,ZAPI 使用 0..11 范围,而 REST 使用 1..12。

使用 ZAPI 时默认为 0,使用 REST 时默认为 1。

设置为 0 时,将拒绝 12 或更高的值。

设置为 1 时,将拒绝 0 或 13 或更高的值。

选项

  • 0

  • 1

name

字符串 / 必需

要管理的作业调度的名称。

ontapi

整数

要使用的 ontap api 版本

password

别名:pass

字符串

指定用户的密码。

state

字符串

指定的作业调度是否存在。

选项

  • "present" ← (默认)

  • "absent"

use_rest

字符串

是否使用 REST 或 ZAPI。

always – 如果模块支持 REST,则始终使用 REST API。如果模块不支持 REST,则会发出警告。如果模块选项在 REST 中不受支持,则会发出错误。

never – 如果模块支持 ZAPI,则始终使用 ZAPI。如果 REST 选项在 ZAPI 中不受支持,则可能会发出错误。

auto – 如果模块支持 REST 并且支持模块选项,则将尝试使用 REST API。否则恢复为 ZAPI。

默认值: "auto"

用户名

别名:user

字符串

这可以是集群范围或SVM范围的帐户,具体取决于是否需要集群级或SVM级API。

更多信息,请阅读文档 https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/

支持两种身份验证方法

  1. 基本身份验证,使用用户名和密码;

  2. SSL证书身份验证,使用SSL客户端证书文件,并可选地使用私钥文件。

要使用证书,必须已在ONTAP集群中安装证书,并且必须已启用证书身份验证。

validate_certs

布尔值

如果设置为 no,则不会验证SSL证书。

仅当在使用自签名证书的个人控制站点上使用时,才应将其设置为 False

选项

  • false

  • true ← (默认)

备注

注意

  • 以na_ontap为前缀的模块构建为支持ONTAP存储平台。

  • 默认情况下启用https,建议使用。要在集群上启用http,您必须运行以下命令“set -privilege advanced;” “system services web modify -http-enabled true;”。

示例

- 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 }}"

作者

  • NetApp Ansible团队 (@carchi8py)