community.general.oneview_fcoe_network_info 模块 – 获取一个或多个 OneView FCoE 网络的信息

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.general。您需要更多要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：community.general.oneview_fcoe_network_info。

概要 

从 OneView 中检索一个或多个 FCoE 网络的信息。

要求 

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

Python >= 2.7.9
hpOneView >= 2.0.1

参数 

参数	注释
api_version 整数	OneView API 版本。
config 路径	包含 OneView 客户端配置的 JSON 配置文件的路径。配置文件是可选的，如果使用，则应存在于运行 ansible 命令的主机中。如果未提供文件路径，则将从环境变量加载配置。有关示例配置文件或如何使用环境变量的链接，请验证注释部分。
hostname 字符串	设备的 IP 地址或主机名。
image_streamer_hostname 字符串	HPE Image Streamer REST API 的 IP 地址或主机名。
name 字符串	FCoE 网络名称。
params 字典	用于分隔、筛选和排序资源列表的参数列表。允许的参数键是 `start`：要返回的第一个项目，使用从 0 开始的索引。 `count`：要返回的资源数量。 `filter`：用于缩小返回项目列表的通用筛选器/查询字符串。 `sort`：返回数据集的排序顺序。
password 字符串	用于 API 身份验证的密码。
username 字符串	用于 API 身份验证的用户名。

属性 

属性	支持	描述
check_mode	支持：完整在 community.general 3.3.0 中添加此操作不会修改状态。	可以在 `check_mode` 中运行并返回更改的状态预测，而无需修改目标。
diff_mode	支持：不适用此操作不会修改状态。	在差异模式下，将返回已更改的内容的详细信息（或可能需要在 `check_mode` 中更改的内容）。

注释 

注意

可以在以下位置找到 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: Gather information about all FCoE Networks
  community.general.oneview_fcoe_network_info:
    config: /etc/oneview/oneview_config.json
  delegate_to: localhost
  register: result

- name: Print fetched information about FCoE Networks
  ansible.builtin.debug:
    msg: "{{ result.fcoe_networks }}"

- name: Gather paginated, filtered and sorted information about FCoE Networks
  community.general.oneview_fcoe_network_info:
    config: /etc/oneview/oneview_config.json
    params:
      start: 0
      count: 3
      sort: 'name:descending'
      filter: 'vlanId=2'
  delegate_to: localhost
  register: result

- name: Print fetched information about paginated, filtered and sorted list of FCoE Networks
  ansible.builtin.debug:
    msg: "{{ result.fcoe_networks }}"

- name: Gather information about a FCoE Network by name
  community.general.oneview_fcoe_network_info:
    config: /etc/oneview/oneview_config.json
    name: Test FCoE Network Information
  delegate_to: localhost
  register: result

- name: Print fetched information about FCoE Network found by name
  ansible.builtin.debug:
    msg: "{{ result.fcoe_networks }}"

返回值 

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

键	描述
fcoe_networks 字典	具有有关 FCoE 网络的所有 OneView 信息。已返回：始终，但可以为空。

作者

Felipe Bulsoni (@fgbulsoni)
Thiago Miotto (@tmiotto)
Adriane Cardozo (@adriane-cardozo)