community.general.oneview_fc_network 模块 – 管理 OneView 光纤通道网络资源
注意
此模块是 community.general 集合 (版本 10.1.0) 的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install community.general
。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求。
要在 playbook 中使用它,请指定:community.general.oneview_fc_network
。
概要
提供用于管理光纤通道网络资源的接口。可以创建、更新和删除。
要求
在执行此模块的主机上需要以下要求。
Python >= 2.7.9
hpOneView >= 4.0.0
参数
参数 |
注释 |
---|---|
OneView API 版本。 |
|
指向包含 OneView 客户端配置的 JSON 配置文件的路径。配置文件是可选的,使用时应存在于运行 Ansible 命令的主机中。如果未提供文件路径,则配置将从环境变量加载。有关示例配置文件的链接或如何使用环境变量,请验证注释部分。 |
|
包含光纤通道网络属性的列表。 |
|
设备的 IP 地址或主机名。 |
|
HPE Image Streamer REST API 的 IP 地址或主机名。 |
|
API 身份验证的密码。 |
|
指示光纤通道网络资源的所需状态。 选项
|
|
API 身份验证的用户名。 |
|
启用 ETag 验证时,只有当资源的当前 ETag 与数据中提供的 ETag 匹配时,请求才会被有条件地处理。 选项
|
属性
属性 |
支持 |
描述 |
---|---|---|
支持:不支持 |
可以在 |
|
支持:不支持 |
处于 diff 模式时,将返回有关已更改内容(或可能需要在 |
注释
注意
可在以下位置找到 config 参数的示例配置文件:https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json
查看如何在以下位置使用环境变量进行配置:https://github.com/HewlettPackard/oneview-ansible#environment-variables
可在以下位置找到 HPE OneView Ansible 模块的其他 Playbook:https://github.com/HewlettPackard/oneview-ansible/tree/master/examples
使用的 OneView API 版本将直接影响资源中返回和预期的字段。有关设置所需 API 版本的信息,请访问:https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version
示例
- name: Ensure that the Fibre Channel Network is present using the default configuration
community.general.oneview_fc_network:
config: "{{ config_file_path }}"
state: present
data:
name: 'New FC Network'
- name: Ensure that the Fibre Channel Network is present with fabricType 'DirectAttach'
community.general.oneview_fc_network:
config: "{{ config_file_path }}"
state: present
data:
name: 'New FC Network'
fabricType: 'DirectAttach'
- name: Ensure that the Fibre Channel Network is present and is inserted in the desired scopes
community.general.oneview_fc_network:
config: "{{ config_file_path }}"
state: present
data:
name: 'New FC Network'
scopeUris:
- '/rest/scopes/00SC123456'
- '/rest/scopes/01SC123456'
- name: Ensure that the Fibre Channel Network is absent
community.general.oneview_fc_network:
config: "{{ config_file_path }}"
state: absent
data:
name: 'New FC Network'
返回值
常见返回值已记录在 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
包含关于受管理的 OneView 光纤通道网络的事实。 返回:在状态“present”时。可以为 null。 |