dellemc.openmanage.ome_network_vlan 模块 – 创建、修改和删除 VLAN
注意
此模块是 dellemc.openmanage 集合 (版本 9.9.0) 的一部分。
如果您使用的是 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install dellemc.openmanage
。您需要其他要求才能使用此模块,请参阅 需求 获取详细信息。
要在 playbook 中使用它,请指定:dellemc.openmanage.ome_network_vlan
。
dellemc.openmanage 2.1.0 中的新增功能
概要
此模块允许:
在 OpenManage Enterprise 上创建 VLAN。
修改或删除 OpenManage Enterprise 上的现有 VLAN。
需求
执行此模块的主机需要以下需求。
python >= 3.9.6
参数
参数 |
注释 |
---|---|
包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。 |
|
要创建或修改的 VLAN 的简短描述。 |
|
OpenManage Enterprise 或 OpenManage Enterprise Modular 的 IP 地址或主机名。 |
|
提供要创建、删除或修改的 VLAN 的名称。 |
|
提供要修改的 VLAN 的名称。 |
|
OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。 如果未提供密码,则使用环境变量 示例:export OME_PASSWORD=password |
|
OpenManage Enterprise 或 OpenManage Enterprise Modular HTTPS 端口。 默认值: |
|
警告 删除 VLAN 会影响网络基础设施。 选项
|
|
以秒为单位的套接字级别超时。 默认值: |
|
支持的 VLAN 网络类型。 有关每种网络类型的描述,请使用 API https://I(hostname/api/NetworkConfigurationService/NetworkTypes)。 选项
|
|
OpenManage Enterprise 或 OpenManage Enterprise Modular 用户名。 如果未提供用户名,则使用环境变量 示例:export OME_USERNAME=username |
|
如果为 仅在使用自签名证书的个人控制站点上配置 在集合版本 选项
|
|
范围的最大 VLAN 值。 如果 vlan_maximum 和 vlan_minmum 值相同,则创建单个 VLAN 值。 |
|
范围的最小 VLAN 值。 |
|
身份验证令牌。 如果未提供 x_auth_token,则使用环境变量 示例:export OME_X_AUTH_TOKEN=x_auth_token |
注释
注意
从此模块可以直接访问 Dell OpenManage Enterprise 的系统运行此模块。
此模块支持
check_mode
。
示例
---
- name: Create a VLAN range
dellemc.openmanage.ome_network_vlan:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
ca_path: "/path/to/ca_cert.pem"
state: present
name: "vlan1"
description: "VLAN desc"
type: "General Purpose (Bronze)"
vlan_minimum: 35
vlan_maximum: 40
tags: create_vlan_range
- name: Create a VLAN with a single value
dellemc.openmanage.ome_network_vlan:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
ca_path: "/path/to/ca_cert.pem"
state: present
name: "vlan2"
description: "VLAN desc"
type: "General Purpose (Bronze)"
vlan_minimum: 127
vlan_maximum: 127
tags: create_vlan_single
- name: Modify a VLAN
dellemc.openmanage.ome_network_vlan:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
ca_path: "/path/to/ca_cert.pem"
state: present
name: "vlan1"
new_name: "vlan_gold1"
description: "new description"
type: "General Purpose (Gold)"
vlan_minimum: 45
vlan_maximum: 50
tags: modify_vlan
- name: Delete a VLAN
dellemc.openmanage.ome_network_vlan:
hostname: "{{hostname}}"
username: "{{username}}"
password: "{{password}}"
ca_path: "/path/to/ca_cert.pem"
state: "absent"
name: "vlan1"
tags: delete_vlan
返回值
常见的返回值已在此处记录,以下是此模块特有的字段
键 |
描述 |
---|---|
HTTP错误的详细信息。 返回:HTTP错误时 示例: |
|
VLAN操作的总体状态。 返回:始终 示例: |
|
已创建或修改的VLAN的详细信息。 返回:当state=present时 示例: |