community.general.spectrum_device 模块 – 在 CA Spectrum 中创建/删除设备

注意

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

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

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

要在 playbook 中使用它,请指定: community.general.spectrum_device

概要

参数

参数

注释

agentport

整数

用于 SNMP 发现的 UDP 端口。

默认值: 161

community

字符串 / 必需

用于设备发现的 SNMP community。

state=present 时必需。

device

别名:host, name

字符串 / 必需

设备的 IP 地址。

如果给出主机名,它将被解析为 IP 地址。

landscape

字符串 / 必需

添加或删除设备的 SpectroServer 的 Landscape 句柄。

state

字符串

present 时,如果设备不存在则创建设备。

absent 时,如果设备存在则删除设备。

选项

  • "present" ← (默认)

  • "absent"

url

别名:oneclick_url

字符串 / 必需

Oneclick 服务器的 HTTP、HTTPS URL,格式为 (http|https)://host.domain[:port]

url_password

别名:oneclick_password

字符串 / 必需

Oneclick 用户密码。

url_username

别名:oneclick_user

字符串 / 必需

Oneclick 用户名。

use_proxy

布尔值

如果为 false,则即使目标主机上的环境变量中定义了代理,也不会使用代理。

选项

  • false

  • true ← (默认)

validate_certs

布尔值

如果 false,则不会验证 SSL 证书。这应该只用于使用自签名证书的个人控制站点。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持:完全支持

可以在 check_mode 下运行,并在不修改目标的情况下返回更改状态预测。

diff_mode

支持:不支持

在 diff 模式下,将返回有关已更改内容(或可能需要在 check_mode 中更改的内容)的详细信息。

备注

注意

  • 设备将在指定 landscape 的 *Universe* 容器内创建。

  • 所有操作都将只在指定的 landscape 上执行。

示例

- name: Add device to CA Spectrum
  local_action:
    module: spectrum_device
    device: '{{ ansible_host }}'
    community: secret
    landscape: '0x100000'
    oneclick_url: http://oneclick.example.com:8080
    oneclick_user: username
    oneclick_password: password
    state: present


- name: Remove device from CA Spectrum
  local_action:
    module: spectrum_device
    device: '{{ ansible_host }}'
    landscape: '{{ landscape_handle }}'
    oneclick_url: http://oneclick.example.com:8080
    oneclick_user: username
    oneclick_password: password
    use_proxy: false
    state: absent

返回值

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

描述

device

字典

当 state = present 时的设备数据

返回:成功

示例: {"address": "10.10.5.1", "landscape": "0x100000", "model_handle": "0x1007ab"}

作者

  • Renato Orgito (@orgito)