community.general.oneview_ethernet_network_info – Получение информации об одной или нескольких сетевых инфраструктурах Ethernet OneView
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.oneview_ethernet_network_info.
Обзор
- Получение информации об одной или нескольких сетевых инфраструктурах Ethernet из OneView.
- Этот модуль назывался
oneview_ethernet_network_factsдо Ansible 2.9, возвращаяansible_facts. Обратите внимание, что модуль community.general.oneview_ethernet_network_info больше не возвращаетansible_facts!
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- hpOneView >= 2.0.1
- python >= 2.7.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| config путь | Путь к файлу конфигурации .json, содержащему конфигурацию клиента OneView. Файл конфигурации необязателен и, если используется, должен присутствовать на хосте, выполняющем команды ansible. Если путь к файлу не указан, конфигурация будет загружена из переменных окружения. Для ссылок на примеры файлов конфигурации или способы использования переменных окружения см. раздел "Примечания". | |
| name строка | Имя сетевой инфраструктуры Ethernet. | |
| options строка | Список параметров для сбора дополнительной информации о сетевой инфраструктуре Ethernet и связанных ресурсах. Допускаемые параметры: associatedProfiles и associatedUplinkGroups. | |
| params словарь | Список параметров для ограничения, фильтрации и сортировки списка ресурсов. Разрешенные параметры: - start: Первый возвращаемый элемент с индексацией с нуля. - count: Количество возвращаемых ресурсов. - filter: Общая строка фильтра/запроса для сужения списка возвращаемых элементов. - sort: Порядок сортировки возвращаемого набора данных. |
Примечания
Примечание
- Пример файла конфигурации для параметра config можно найти по адресу: https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json
- Инструкции по использованию переменных окружения для конфигурации см. по адресу: https://github.com/HewlettPackard/oneview-ansible#environment-variables
- Дополнительные книги задач для модулей Ansible HPE OneView можно найти по адресу: https://github.com/HewlettPackard/oneview-ansible/tree/master/examples
- Версия API OneView, используемая модулем, напрямую влияет на возвращаемые и ожидаемые поля в ресурсах. Информацию о настройке желаемой версии API см. по адресу: https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version
Примеры
- name: Gather information about all Ethernet Networks
community.general.oneview_ethernet_network_info:
config: /etc/oneview/oneview_config.json
delegate_to: localhost
register: result
- ansible.builtin.debug:
msg: "{{ result.ethernet_networks }}"
- name: Gather paginated and filtered information about Ethernet Networks
community.general.oneview_ethernet_network_info:
config: /etc/oneview/oneview_config.json
params:
start: 1
count: 3
sort: 'name:descending'
filter: 'purpose=General'
delegate_to: localhost
register: result
- ansible.builtin.debug:
msg: "{{ result.ethernet_networks }}"
- name: Gather information about an Ethernet Network by name
community.general.oneview_ethernet_network_info:
config: /etc/oneview/oneview_config.json
name: Ethernet network name
delegate_to: localhost
register: result
- ansible.builtin.debug:
msg: "{{ result.ethernet_networks }}"
- name: Gather information about an Ethernet Network by name with options
community.general.oneview_ethernet_network_info:
config: /etc/oneview/oneview_config.json
name: eth1
options:
- associatedProfiles
- associatedUplinkGroups
delegate_to: localhost
register: result
- ansible.builtin.debug:
msg: "{{ result.enet_associated_profiles }}"
- ansible.builtin.debug:
msg: "{{ result.enet_associated_uplink_groups }}"
Возвращаемые значения
Общие возвращаемые значения описаны в данном разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| enet_associated_profiles словарь | Если запрошено, но может быть нулевым. | Содержит всю информацию OneView о профилях, использующих сетевую инфраструктуру Ethernet. |
| enet_associated_uplink_groups словарь | Если запрошено, но может быть нулевым. | Содержит всю информацию OneView о группах Uplink, использующих сетевую инфраструктуру Ethernet. |
| ethernet_networks словарь | Всегда, но может быть нулевым. | Содержит всю информацию OneView о сетевых инфраструктурах Ethernet. |
Авторы
- Felipe Bulsoni (@fgbulsoni)
- Thiago Miotto (@tmiotto)
- Adriane Cardozo (@adriane-cardozo)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/oneview_ethernet_network_info_module.html