community.general.oneview_fc_network_info 模块 – 获取一个或多个 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_info。

概要 

从 OneView 获取一个或多个光纤通道网络的信息。

要求 

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

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 字符串	光纤通道网络名称。
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 Fibre Channel Networks
  community.general.oneview_fc_network_info:
    config: /etc/oneview/oneview_config.json
  delegate_to: localhost
  register: result

- name: Print fetched information about Fibre Channel Networks
  ansible.builtin.debug:
    msg: "{{ result.fc_networks }}"

- name: Gather paginated, filtered and sorted information about Fibre Channel Networks
  community.general.oneview_fc_network_info:
    config: /etc/oneview/oneview_config.json
    params:
      start: 1
      count: 3
      sort: 'name:descending'
      filter: 'fabricType=FabricAttach'
  delegate_to: localhost
  register: result

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

- name: Gather information about a Fibre Channel Network by name
  community.general.oneview_fc_network_info:
    config: /etc/oneview/oneview_config.json
    name: network name
  delegate_to: localhost
  register: result

- name: Print fetched information about Fibre Channel Network found by name
  ansible.builtin.debug:
    msg: "{{ result.fc_networks }}"

返回值 

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

键	描述
fc_networks 字典	具有有关光纤通道网络的所有 OneView 信息。返回: 总是返回，但可以为空。

作者

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