community.general.oneview_ethernet_network_facts – Получение информации об одной или нескольких Ethernet-сетях OneView

Примечание

Этот плагин является частью коллекции community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в плейбуке укажите: community.general.oneview_ethernet_network_facts.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Получение информации об одной или нескольких 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
Дополнительные плейбуки для модулей HPE OneView Ansible можно найти по адресу: 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_facts_module.html