ibm.storage_virtualize.ibm_svc_manage_callhome 模块 – 此模块管理 IBM Storage Virtualize 系列系统上的 Call Home 功能配置

注意

此模块是 ibm.storage_virtualize 集合(版本 2.5.0)的一部分。

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

要安装它,请使用:ansible-galaxy collection install ibm.storage_virtualize

要在 playbook 中使用它,请指定:ibm.storage_virtualize.ibm_svc_manage_callhome

ibm.storage_virtualize 1.7.0 中的新功能

概要

  • 管理云和电子邮件 Call Home 功能的 Ansible 接口。

参数

参数

注释

地址

字符串

指定用户的地址的第一行,它应在 Call Home 电子邮件中显示。

当 *state=enabled* 时,为必填项。

callhome_type

字符串 / 必填

指定传输类型。

选项

  • "云服务"

  • "电子邮件"

  • "两者"

censorcallhome

字符串

指定从增强型 Call Home 数据中删除敏感数据。

当 *state=enabled* 时适用。

如果未指定,将使用默认值 “off”。

选项

  • "on"

  • "off"

城市

字符串

指定用户的城市,它应在 Call Home 电子邮件中显示。

当 *state=enabled* 时,为必填项。

clustername

字符串 / 必填

Storage Virtualize 系统的hostname 或管理 IP。

company_name

字符串

指定用户的组织,它应在 Call Home 电子邮件中显示。

当 *state=enabled* 时,为必填项。

contact_email

字符串

指定人员的电子邮件。

当 *state=enabled* 时,为必填项。

contact_name

字符串

指定接收电子邮件的人员姓名。

当 *state=enabled* 时,为必填项。

国家/地区

字符串

指定机器所在的国家/地区,它应在 Call Home 电子邮件中显示。

当 *state=enabled* 时,为必填项。

字符串

Storage Virtualize 系统的域。

当主机名用于参数 *clustername* 时有效。

enhancedcallhome

字符串

指定 Call Home 功能是否向支持中心发送增强报告。

当 *state=enabled* 时适用。

如果未指定,将使用默认值 “off”。

选项

  • "on"

  • "off"

invemailinterval

整数

指定向配置的电子邮件收件人发送清单电子邮件的间隔。

间隔以天为单位度量。该值必须在 0 - 15 的范围内。

将该值设置为 “0” 会关闭清单电子邮件通知功能。如果 *inventory* 设置为 “on”,则有效。

inventory

字符串

指定参数 *contact_email* 中提及的收件人是否接收清单电子邮件通知。

当 *state=enabled* 时适用。如果未指定,将使用默认值 “off”。

选项

  • "on"

  • "off"

位置

字符串

指定报告错误的系统的物理位置。

当 *state=enabled* 时,为必填项。

log_path

字符串

调试日志文件的路径。

密码

字符串

Storage Virtualize 系统的 REST API 密码。

如果未使用 *token* 验证用户身份,则需要参数 *username* 和 *password*。

phonenumber_primary

字符串

指定主要联系电话号码。

当 *state=enabled* 时,为必填项。

phonenumber_secondary

字符串

指定辅助联系电话号码。

当 *state=enabled* 时,为必填项。

邮政编码

字符串

指定用户的邮政编码,它应在 Call Home 电子邮件中显示。

当 *state=enabled* 时,为必填项。

省/自治区

字符串

指定用户的州或省/自治区,它应在 Call Home 电子邮件中显示。

当 *state=enabled* 时,为必填项。

proxy_password

字符串

指定代理的密码。

当 *state=enabled* 且 *proxy_type=basic_authentication* 时适用。

proxy_port

整数

指定代理服务器端口号。该值必须在 1 - 65535 的范围内。

当 *state=enabled* 且 *proxy_type=open_proxy* 或 *proxy_type=basic_authentication* 时适用。

proxy_type

字符串

指定代理类型。

当 *state=enabled* 时,创建或修改 Call Home 功能时为必填项。

将为 *proxy_type=no_proxy* 删除代理。

当 *callhome_type='cloud services'*)或 *callhome_type='both'* 时,此参数是强制性的。

选项

  • "open_proxy"

  • "basic_authentication"

  • "certificate"

  • "no_proxy"

proxy_url

字符串

使用完全限定的域名格式中的协议前缀指定代理服务器 URL。

当 *state=enabled* 且 *proxy_type=open_proxy* 或 *proxy_type=basic_authentication* 时适用。

proxy_username

字符串

指定代理的用户名。

当 *state=enabled* 且 *proxy_type=basic_authentication* 时适用。

serverIP

字符串

指定电子邮件服务器的 IP 地址。

当 *state=enabled* 且 *callhome_type=email* 或 *callhome_type=both* 时,为必填项。

serverPort

整数

指定电子邮件服务器的端口号。

该值必须在 1 - 65535 的范围内。

当 *state=enabled* 且 *callhome_type=email* 或 *callhome_type=both* 时,为必填项。

sslcert

字符串

指定代理证书的文件路径。

当 *state=enabled* 且 *proxy_type=certificate* 时适用。

state

字符串 / 必填

启用或更新(enabled)或禁用(disabled)Call Home 功能。

选项

  • "enabled"

  • "disabled"

令牌

字符串

用于验证 Storage Virtualize 系统上用户的身份验证令牌。

要生成令牌,请使用 ibm_svc_auth 模块。

用户名

字符串

Storage Virtualize 系统的 REST API 用户名。

如果未使用 *token* 验证用户身份,则需要参数 *username* 和 *password*。

验证证书

布尔值

验证证书。

选项

  • false ← (默认)

  • true

说明

注意

  • 此模块支持 check_mode

示例

- name: Configure callhome with both email and cloud
  ibm.storage_virtualize.ibm_svc_manage_callhome:
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    password: "{{ password }}"
    log_path: "/tmp/playbook.debug"
    state: "enabled"
    callhome_type: "both"
    address: "{{ address }}"
    city: "{{ city }}"
    company_name: "{{ company_name }}"
    contact_email: "{{ contact_email }}"
    contact_name: "{{ contact_name }}"
    country: "{{ country }}"
    location: "{{ location }}"
    phonenumber_primary: "{{ primary_phonenumber }}"
    postalcode: "{{ postal_code }}"
    province: "{{ province }}"
    proxy_type: "{{ proxy_type }}"
    proxy_url: "{{ proxy_url }}"
    proxy_port: "{{ proxy_port }}"
    serverIP: "{{ server_ip }}"
    serverPort: "{{ server_port }}"
    inventory: "on"
    invemailinterval: 1
    enhancedcallhome: "on"
    censorcallhome: "on"

- name: Configure callhome with cloud
  ibm.storage_virtualize.ibm_svc_manage_callhome:
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    password: "{{ password }}"
    log_path: "/tmp/playbook.debug"
    state: "enabled"
    callhome_type: "cloud services"
    province: "{{ province }}"
    proxy_type: "{{ proxy_type }}"
    proxy_url: "{{ proxy_url }}"
    proxy_port: "{{ proxy_port }}"

- name: Configure callhome with email
  ibm.storage_virtualize.ibm_svc_manage_callhome:
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    password: "{{ password }}"
    log_path: "/tmp/playbook.debug"
    state: "enabled"
    callhome_type: "email"
    contact_email: "{{ contact_email }}"
    serverIP: "{{ server_ip }}"
    serverPort: "{{ server_port }}"

作者

  • Sreshtant Bohidar(@Sreshtant-Bohidar)

  • Sandip Gulab Rajbanshi (@Sandip-Rajbanshi)