kaytus.ksmanage.edit_preserve_config 模块 – 设置保留配置

注意

此模块是 kaytus.ksmanage 集合 (版本 2.0.0) 的一部分。

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

要安装它,请使用:ansible-galaxy collection install kaytus.ksmanage。您需要满足其他要求才能使用此模块,有关详细信息,请参阅要求

要在 playbook 中使用它,请指定:kaytus.ksmanage.edit_preserve_config

kaytus.ksmanage 1.0.0 中的新功能

概要

  • 在 kaytus 服务器上设置保留配置。

要求

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

  • Python 3.7+

  • inManage

参数

参数

注释

主机

字符串

指定用于通过指定传输连接到远程设备的 DNS 主机名或地址。主机的值用作传输的目标地址。

覆盖

列表 / 元素=字符串

需要保留的配置项。

setting=manual时为必填项。

选项

  • “authentication”

  • “dcmi”

  • “fru”

  • “hostname”

  • “ipmi”

  • “kvm”

  • “network”

  • “ntp”

  • “pef”

  • “sdr”

  • “sel”

  • “smtp”

  • “snmp”

  • “sol”

  • “ssh”

  • “syslog”

  • “user”

密码

字符串

指定用于验证与远程设备连接的密码。如果任务中未指定该值,则将使用环境变量 ANSIBLE_NET_PASSWORD 的值。

提供程序

字典

包含连接详细信息的字典对象。

主机

字符串

指定用于通过指定传输连接到远程设备的 DNS 主机名或地址。主机的值用作传输的目标地址。

密码

字符串

指定用于验证与远程设备连接的密码。如果任务中未指定该值,则将使用环境变量 ANSIBLE_NET_PASSWORD 的值。

用户名

字符串

配置用于验证与远程设备连接的用户名。如果任务中未指定该值,则将使用环境变量 ANSIBLE_NET_USERNAME 的值。

设置

字符串 / 必需

保留选项,all - 保留所有配置;none - 覆盖所有配置;manual - 手动选择。

选项

  • “all”

  • “none”

  • “manual”

用户名

字符串

配置用于验证与远程设备连接的用户名。如果任务中未指定该值,则将使用环境变量 ANSIBLE_NET_USERNAME 的值。

注意

注意

  • 不支持 check_mode

示例

- name: Preserve test
  hosts: ksmanage
  connection: local
  gather_facts: false
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set preserve all"
    kaytus.ksmanage.edit_preserve_config:
      setting: "all"
      provider: "{{ ksmanage }}"

  - name: "Set preserve none"
    edit_preserve_config:
      setting: "none"
      provider: "{{ ksmanage }}"

  - name: "Set preserve manual"
    edit_preserve_config:
      setting: "manual"
      override:
        - fru
        - ntp
        - network
        - user
      provider: "{{ ksmanage }}"

返回值

常用返回值已在此处记录 此处,以下是此模块特有的字段

描述

已更改

布尔值

检查设备是否进行了更改。

已返回: 始终

消息

字符串

模块执行后返回的消息。

已返回: 始终

状态

字符串

模块执行后的状态。

已返回: 始终

作者

  • WangBaoshan (@ieisystem)