community.vmware.vmware_vcenter_settings 模块 – 配置 vCenter Server 上的常规设置

注意

此模块是 community.vmware 集合 (版本 5.2.0) 的一部分。

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

要安装它,请使用:ansible-galaxy collection install community.vmware

要在 playbook 中使用它,请指定:community.vmware.vmware_vcenter_settings

概要

参数

参数

注释

advanced_settings

字典

高级设置的字典。

默认值: {}

database

字典

vCenter Server 的数据库设置。

默认值: {"event_cleanup": true, "event_retention": 30, "max_connections": 50, "task_cleanup": true, "task_retention": 30}

event_cleanup

布尔值

事件清理。

选择

  • false

  • true ← (默认)

event_retention

整数

事件保留天数。

默认值: 30

max_connections

整数

最大连接数。

默认值: 50

task_cleanup

布尔值

任务清理。

选择

  • false

  • true ← (默认)

task_retention

整数

任务保留天数。

默认值: 30

hostname

字符串

vSphere vCenter 或 ESXi Server 的主机名或 IP 地址。

如果未在任务中指定该值,则将改用环境变量 VMWARE_HOST 的值。

logging_options

字符串

vCenter Server 用于日志文件的详细程度。

选择

  • "none"

  • "error"

  • "warning"

  • "info" ← (默认)

  • "verbose"

  • "trivia"

mail

字典

vCenter Server 用于发送电子邮件警报的设置。

默认值: {"sender": "", "server": ""}

sender

字符串

邮件发件人地址。

server

字符串

邮件服务器。

password

别名:pass, pwd

字符串

vSphere vCenter 或 ESXi Server 的密码。

如果未在任务中指定该值,则将改用环境变量 VMWARE_PASSWORD 的值。

port

整数

vSphere vCenter 或 ESXi Server 的端口号。

如果未在任务中指定该值,则将改用环境变量 VMWARE_PORT 的值。

默认值: 443

proxy_host

字符串

将接收所有 HTTPS 请求并转发它们的代理的地址。

格式是主机名或 IP。

如果未在任务中指定该值,则将改用环境变量 VMWARE_PROXY_HOST 的值。

proxy_port

整数

将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。

如果未在任务中指定该值,则将改用环境变量 VMWARE_PROXY_PORT 的值。

runtime_settings

字典

vCenter Server 的唯一运行时设置。

managed_address

字符串

vCenter Server 管理地址。

unique_id

整数

vCenter Server 唯一 ID。

vcenter_server_name

字符串

vCenter Server 名称。默认值为 FQDN。

snmp_receivers

字典

vCenter Server 警报的 SNMP 陷阱目标。

默认值: {"snmp_receiver_1_community": "public", "snmp_receiver_1_enabled": true, "snmp_receiver_1_port": 162, "snmp_receiver_1_url": "localhost", "snmp_receiver_2_community": "", "snmp_receiver_2_enabled": false, "snmp_receiver_2_port": 162, "snmp_receiver_2_url": "", "snmp_receiver_3_community": "", "snmp_receiver_3_enabled": false, "snmp_receiver_3_port": 162, "snmp_receiver_3_url": "", "snmp_receiver_4_community": "", "snmp_receiver_4_enabled": false, "snmp_receiver_4_port": 162, "snmp_receiver_4_url": ""}

snmp_receiver_1_community

字符串

团体字符串。

默认值: "public"

snmp_receiver_1_enabled

布尔值

启用接收器。

选择

  • false

  • true ← (默认)

snmp_receiver_1_port

整数

接收器端口。

默认值: 162

snmp_receiver_1_url

字符串

主接收器URL。

默认值: "localhost"

snmp_receiver_2_community

字符串

团体字符串。

默认值: ""

snmp_receiver_2_enabled

布尔值

启用接收器。

选择

  • false ← (默认)

  • true

snmp_receiver_2_port

整数

接收器端口。

默认值: 162

snmp_receiver_2_url

字符串

接收器 2 URL。

默认值: ""

snmp_receiver_3_community

字符串

团体字符串。

默认值: ""

snmp_receiver_3_enabled

布尔值

启用接收器。

选择

  • false ← (默认)

  • true

snmp_receiver_3_port

整数

接收器端口。

默认值: 162

snmp_receiver_3_url

字符串

接收器 3 URL。

默认值: ""

snmp_receiver_4_community

字符串

团体字符串。

默认值: ""

snmp_receiver_4_enabled

布尔值

启用接收器。

选择

  • false ← (默认)

  • true

snmp_receiver_4_port

整数

接收器端口。

默认值: 162

snmp_receiver_4_url

字符串

接收器 4 URL。

默认值: ""

timeout_settings

字典

vCenter 服务器连接超时,用于普通和长时间操作。

默认值: {"long_operations": 120, "normal_operations": 30}

long_operations

整数

长时间操作超时。

默认值: 120

normal_operations

整数

普通操作超时。

默认值: 30

user_directory

字典

vCenter 服务器安装的用户目录设置。

默认值: {"query_limit": true, "query_limit_size": 5000, "timeout": 60, "validation": true, "validation_period": 1440}

query_limit

布尔值

查询限制。

选择

  • false

  • true ← (默认)

query_limit_size

整数

查询限制大小。

默认值: 5000

timeout

整数

用户目录超时。

默认值: 60

validation

布尔值

邮件验证。

选择

  • false

  • true ← (默认)

validation_period

整数

验证周期。

默认值: 1440

username

别名: admin, user

字符串

vSphere vCenter 或 ESXi 服务器的用户名。

如果任务中未指定该值,则将使用环境变量 VMWARE_USER 的值。

validate_certs

布尔值

允许在 SSL 证书无效时进行连接。当证书不受信任时设置为 false

如果任务中未指定该值,则将使用环境变量 VMWARE_VALIDATE_CERTS 的值。

选择

  • false

  • true ← (默认)

说明

注意

  • 所有模块都需要 API 写入访问权限,因此在免费 ESXi 许可证上不受支持。

  • 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Configure vCenter general settings
  community.vmware.vmware_vcenter_settings:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    database:
      max_connections: 50
      task_cleanup: true
      task_retention: 30
      event_cleanup: true
      event_retention: 30
    runtime_settings:
      unique_id: 1
      managed_address: "{{ lookup('dig', inventory_hostname) }}"
      vcenter_server_name: "{{ inventory_hostname }}"
    user_directory:
      timeout: 60
      query_limit: true
      query_limit_size: 5000
      validation: true
      validation_period: 1440
    mail:
      server: mail.example.com
      sender: vcenter@{{ inventory_hostname }}
    snmp_receivers:
      snmp_receiver_1_url: localhost
      snmp_receiver_1_enabled: true
      snmp_receiver_1_port: 162
      snmp_receiver_1_community: public
    timeout_settings:
      normal_operations: 30
      long_operations: 120
    logging_options: info
  delegate_to: localhost

- name: Enable Retreat Mode for cluster with MOID domain-c8 (https://kb.vmware.com/kb/80472)
  community.vmware.vmware_vcenter_settings:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    advanced_settings:
      'config.vcls.clusters.domain-c8.enabled': 'false'
  delegate_to: localhost

返回值

通用返回值记录在此处 这里,以下是此模块独有的字段

描述

results

字典

关于 vCenter 设置的元数据

从 1.8.0 版本开始支持 diff 模式

返回: 总是

示例: {"changed": false, "db_event_cleanup": true, "db_event_retention": 30, "db_max_connections": 50, "db_task_cleanup": true, "db_task_retention": 30, "diff": {"after": {"db_event_cleanup": true, "db_event_retention": 30, "db_max_connections": 50, "db_task_cleanup": true, "db_task_retention": 30, "directory_query_limit": true, "directory_query_limit_size": 5000, "directory_timeout": 60, "directory_validation": true, "directory_validation_period": 1440, "logging_options": "info", "mail_sender": "[email protected]", "mail_server": "mail.example.com", "runtime_managed_address": "192.168.1.10", "runtime_server_name": "vcenter01.example.com", "runtime_unique_id": 1, "snmp_receiver_1_community": "public", "snmp_receiver_1_enabled": true, "snmp_receiver_1_port": 162, "snmp_receiver_1_url": "localhost", "snmp_receiver_2_community": "", "snmp_receiver_2_enabled": false, "snmp_receiver_2_port": 162, "snmp_receiver_2_url": "", "snmp_receiver_3_community": "", "snmp_receiver_3_enabled": false, "snmp_receiver_3_port": 162, "snmp_receiver_3_url": "", "snmp_receiver_4_community": "", "snmp_receiver_4_enabled": false, "snmp_receiver_4_port": 162, "snmp_receiver_4_url": "", "timeout_long_operations": 120, "timeout_normal_operations": 30}, "before": {"db_event_cleanup": true, "db_event_retention": 30, "db_max_connections": 50, "db_task_cleanup": true, "db_task_retention": 30, "directory_query_limit": true, "directory_query_limit_size": 5000, "directory_timeout": 60, "directory_validation": true, "directory_validation_period": 1440, "logging_options": "info", "mail_sender": "[email protected]", "mail_server": "mail.example.com", "runtime_managed_address": "192.168.1.10", "runtime_server_name": "vcenter01.example.com", "runtime_unique_id": 1, "snmp_receiver_1_community": "public", "snmp_receiver_1_enabled": true, "snmp_receiver_1_port": 162, "snmp_receiver_1_url": "localhost", "snmp_receiver_2_community": "", "snmp_receiver_2_enabled": false, "snmp_receiver_2_port": 162, "snmp_receiver_2_url": "", "snmp_receiver_3_community": "", "snmp_receiver_3_enabled": false, "snmp_receiver_3_port": 162, "snmp_receiver_3_url": "", "snmp_receiver_4_community": "", "snmp_receiver_4_enabled": false, "snmp_receiver_4_port": 162, "snmp_receiver_4_url": "", "timeout_long_operations": 120, "timeout_normal_operations": 30}}, "directory_query_limit": true, "directory_query_limit_size": 5000, "directory_timeout": 60, "directory_validation": true, "directory_validation_period": 1440, "logging_options": "info", "mail_sender": "[email protected]", "mail_server": "mail.example.com", "msg": "vCenter 设置已正确配置", "runtime_managed_address": "192.168.1.10", "runtime_server_name": "vcenter01.example.com", "runtime_unique_id": 1, "timeout_long_operations": 120, "timeout_normal_operations": 30}

作者

  • Christian Kotte (@ckotte)