community.general.oneview_san_manager_info 模块 – 获取一个或多个 OneView SAN 管理器的信息
注意
此模块是 community.general 集合 (版本 10.1.0) 的一部分。
如果您使用的是 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install community.general
。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求。
要在剧本中使用它,请指定:community.general.oneview_san_manager_info
。
概要
从 OneView 获取一个或多个 SAN 管理器的信息
要求
执行此模块的主机需要以下要求。
Python >= 2.7.9
hpOneView >= 2.0.1
参数
参数 |
注释 |
---|---|
OneView API 版本。 |
|
包含 OneView 客户端配置的 JSON 配置文件的路径。配置文件是可选的,使用时应存在于运行 Ansible 命令的主机上。如果未提供文件路径,则配置将从环境变量加载。有关示例配置文件链接或如何使用环境变量,请验证注释部分。 |
|
设备的 IP 地址或主机名。 |
|
HPE Image Streamer REST API 的 IP 地址或主机名。 |
|
用于限定、筛选和排序资源列表的参数列表。 允许的参数:- |
|
API 身份验证的密码。 |
|
提供商显示名称。 |
|
API 身份验证的用户名。 |
属性
属性 |
支持 |
描述 |
---|---|---|
支持:完全支持 在 community.general 3.3.0 中添加 此操作不会修改状态。 |
可以在 |
|
支持: N/A 此操作不会修改状态。 |
在差异模式下,将返回有关已更改内容(或可能需要在 |
备注
注意
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 模块的其他剧本可在以下位置找到: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 SAN Managers
community.general.oneview_san_manager_info:
config: /etc/oneview/oneview_config.json
delegate_to: localhost
register: result
- name: Print fetched information about SAN Managers
ansible.builtin.debug:
msg: "{{ result.san_managers }}"
- name: Gather paginated, filtered and sorted information about SAN Managers
community.general.oneview_san_manager_info:
config: /etc/oneview/oneview_config.json
params:
start: 0
count: 3
sort: name:ascending
query: isInternal eq false
delegate_to: localhost
register: result
- name: Print fetched information about paginated, filtered and sorted list of SAN Managers
ansible.builtin.debug:
msg: "{{ result.san_managers }}"
- name: Gather information about a SAN Manager by provider display name
community.general.oneview_san_manager_info:
config: /etc/oneview/oneview_config.json
provider_display_name: Brocade Network Advisor
delegate_to: localhost
register: result
- name: Print fetched information about SAN Manager found by provider display name
ansible.builtin.debug:
msg: "{{ result.san_managers }}"
返回值
常用的返回值已在 此处 记录,以下是此模块特有的字段
键 |
描述 |
---|---|
包含有关 SAN 管理器的所有 OneView 信息。 返回:始终返回,但可能为空。 |