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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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`: Первый элемент для возврата, используя индексацию с нуля. `count`: Количество возвращаемых ресурсов. `filter`: Общая строка фильтра/запроса для сужения списка возвращаемых элементов. `sort`: Порядок сортировки возвращаемого набора данных.
password string	Пароль для аутентификации API.
username string	Имя пользователя для аутентификации API.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная добавлено в community.general 3.3.0 Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать предсказание состояния изменения без модификации целевого объекта.
diff_mode	Поддержка: Нет Это действие не изменяет состояние.	Вернет подробности о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), при использовании режима diff.

Примечания

Примечание

Пример конфигурационного файла для параметра 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 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 словарь	Содержит всю информацию OneView о наборах сетей. Возвращается: Всегда, но может быть пустым.

Авторы

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

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

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