netbox.netbox.netbox_fhrp_group 模块 – 在 NetBox 中创建、更新或删除 FHRP 组

注意

此模块是 netbox.netbox 集合（版本 3.20.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install netbox.netbox。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：netbox.netbox.netbox_fhrp_group。

netbox.netbox 3.12.0 中的新增功能

概要

  • 从 NetBox 创建、更新或删除 FHRP 组

要求

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

  • pynetbox

参数

参数

注释

cert

any

证书路径

data

字典 / 必需

定义 FHRP 组配置

auth_key

string

身份验证密钥（最大长度 255）

auth_type

string

身份验证类型

选择

  • "plaintext"

  • "md5"

custom_fields

dictionary

必须在 NetBox 中存在

description

string

描述（最大长度 200）

group_id

整数 / 必需

组 ID (0 .. 32767)

protocol

string

协议

选择

  • "vrrp2"

  • "vrrp3"

  • "carp"

  • "clusterxl"

  • "hsrp"

  • "glbp"

  • "other"

tags

列表 / elements=any

FHRP 组可能需要关联的任何标签

netbox_token

字符串 / 必需

NetBox API 令牌。

netbox_url

字符串 / 必需

NetBox 实例的 URL。

Ansible 控制主机必须可以访问。

query_params

列表 / elements=string

这可以用于覆盖在 plugins/module_utils/netbox_utils.py 中定义的 ALLOWED_QUERY_PARAMS 中的指定值，并允许用户控制在他们的环境中什么可以使对象唯一。

在 plugins/module_utils/netbox_utils.py 中定义，并允许用户控制在他们的环境中什么可以使对象唯一。

在 plugins/module_utils/netbox_utils.py 中定义，并允许用户控制在他们的环境中什么可以使对象唯一。

state

string

对象的状态。

选择

  • "present" ← (默认)

  • "absent"

validate_certs

any

如果 no，则不会验证 SSL 证书。

这应该只在个人控制的站点上使用自签名证书。

默认值： true

注释

注意

  • 标签应定义为 YAML 列表

  • 这应该使用连接 local 和主机 localhost 运行

另请参阅

另请参阅

FHRP 组模型参考

NetBox 关于 FHRP 组模型的文档。

示例

- name: "Test NetBox modules"
  hosts: localhost
  connection: local
  module_defaults:
    group/netbox.netbox.netbox:
      netbox_url: "http://netbox.local"
      netbox_token: "thisIsMyToken"

  tasks:
    - name: "Create FHRP group within netbox"
      netbox.netbox.netbox_fhrp_group:
        data:
          protocol: "glbp"
          group_id: 111
          auth_type: md5
          auth_key: 11111
          description: test FHRP group
        state: present

    - name: Delete FHRP group within netbox
      netbox.netbox.netbox_fhrp_group:
        data:
          group_id: 111
        state: absent

返回值

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

键

描述

fhrp_group

dictionary

在 NetBox 中创建或已经存在的序列化对象

返回：成功（当 state=present 时）

msg

string

指示失败的消息或有关已实现目标的详细信息

返回：始终

作者

  • Andrii Konts (@andrii-konts)