Модуль community.general.oneview_ethernet_network_info — получение информации об одной или нескольких сетях Ethernet OneView

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.oneview_ethernet_network_info.

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

Краткое описание

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

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

Python >= 2.7.9
hpOneView >= 2.0.1

Параметры

Параметр	Комментарии
api_version integer	Версия API OneView.
config path	Путь к файлу конфигурации JSON с конфигурацией клиента OneView. Файл конфигурации необязателен; при его использовании он должен находиться на узле, на котором выполняются команды ansible. Если путь к файлу не указан, конфигурация загружается из переменных среды. Ссылки на примеры файлов конфигурации и сведения об использовании переменных среды см. в разделе примечаний.
hostname string	IP-адрес или имя узла устройства.
image_streamer_hostname string	IP-адрес или имя узла REST API HPE Image Streamer.
name string	Имя сети Ethernet.
options list / elements=string	Список параметров для получения дополнительных сведений о сети Ethernet и связанных ресурсах. Допустимые параметры: `associatedProfiles` и `associatedUplinkGroups`.
params dictionary	Список параметров для ограничения, фильтрации и сортировки списка ресурсов. Допустимые ключи параметров: `start`: первый возвращаемый элемент с индексацией от 0. `count`: количество возвращаемых ресурсов. `filter`: общая строка фильтра/запроса для сужения списка возвращаемых элементов. `sort`: порядок сортировки возвращаемого набора данных.
password string	Пароль для аутентификации в API.
username string	Имя пользователя для аутентификации в API.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная добавлено в community.general 3.3.0 Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: Н/Д Это действие не изменяет состояние.	В режиме diff возвращает сведения об изменениях (или о том, что, возможно, требуется изменить в `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 можно найти здесь: 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

- name: Print fetched information about Ethernet Networks
  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

- name: Print fetched information about paginated and filtered list of Ethernet Networks
  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

- name: Print fetched information about Ethernet Network found by name
  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

- name: Print fetched information about Ethernet Network Associated Profiles
  ansible.builtin.debug:
    msg: "{{ result.enet_associated_profiles }}"

- name: Print fetched information about Ethernet Network Associated Uplink Groups
  ansible.builtin.debug:
    msg: "{{ result.enet_associated_uplink_groups }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
enet_associated_profiles dictionary	Содержит всю информацию OneView о профилях, использующих сеть Ethernet. Возвращается: по запросу; значение может быть null.
enet_associated_uplink_groups dictionary	Содержит всю информацию OneView о группах восходящих каналов, использующих сеть Ethernet. Возвращается: по запросу; значение может быть null.
ethernet_networks dictionary	Содержит всю информацию OneView о сетях Ethernet. Возвращается: всегда; значение может быть null.

Авторы

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

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/oneview_ethernet_network_info_module.html