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

Примечание

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

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

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

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

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

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

Получение информации о наборах сетей из 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	Имя набора сетей.
options list / elements=string	Список параметров для сбора информации о наборе сетей. Допустимый параметр: `withoutEthernet`. Параметр `withoutEthernet` возвращает список network_sets без сетей Ethernet.
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.
Дополнительные плейбуки для модулей 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 Network Sets
  community.general.oneview_network_set_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
  no_log: true
  delegate_to: localhost
  register: result

- name: Print fetched information about Network Sets
  ansible.builtin.debug:
    msg: "{{ result.network_sets }}"

- name: Gather paginated, filtered and sorted information about Network Sets
  community.general.oneview_network_set_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
    params:
      start: 0
      count: 3
      sort: 'name:descending'
      filter: name='netset001'
  no_log: true
  delegate_to: localhost
  register: result

- name: Print fetched information about paginated, filtered and sorted list of Network Sets
  ansible.builtin.debug:
    msg: "{{ result.network_sets }}"

- name: Gather information about all Network Sets, excluding Ethernet networks
  community.general.oneview_network_set_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
    options:
      - withoutEthernet
  no_log: true
  delegate_to: localhost
  register: result

- name: Print fetched information about Network Sets, excluding Ethernet networks
  ansible.builtin.debug:
    msg: "{{ result.network_sets }}"

- name: Gather information about a Network Set by name
  community.general.oneview_network_set_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
    name: Name of the Network Set
  no_log: true
  delegate_to: localhost
  register: result

- name: Print fetched information about Network Set found by name
  ansible.builtin.debug:
    msg: "{{ result.network_sets }}"

- name: Gather information about a Network Set by name, excluding Ethernet networks
  community.general.oneview_network_set_info:
    hostname: 172.16.101.48
    username: administrator
    password: my_password
    api_version: 500
    name: Name of the Network Set
    options:
      - withoutEthernet
  no_log: true
  delegate_to: localhost
  register: result

- name: Print fetched information about Network Set found by name, excluding Ethernet networks
  ansible.builtin.debug:
    msg: "{{ result.network_sets }}"

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

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

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

Авторы

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_network_set_info_module.html