community.general.oneview_network_set_info – Получение информации о наборах сетей OneView
Примечание
Этот плагин входит в сборник community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.oneview_network_set_info.
Обзор
- Получение информации о наборах сетей из OneView.
- Этот модуль назывался
oneview_network_set_factsдо Ansible 2.9, возвращаяansible_facts. Обратите внимание, что модуль community.general.oneview_network_set_info больше не возвращаетansible_facts!
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- hpOneView >= 2.0.1
- python >= 2.7.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| config путь | Путь к файлу конфигурации .json, содержащему конфигурацию клиента OneView. Файл конфигурации необязателен и, если используется, должен присутствовать на хосте, выполняющем команды ansible. Если путь к файлу не указан, конфигурация загружается из переменных среды. Для ссылок на примеры файлов конфигурации или инструкции по использованию переменных среды см. раздел Примечания. | |
| name строка | Имя набора сетей. | |
| options строка | Список опций для сбора информации о наборе сетей. Допустимые опции: withoutEthernet. Опция withoutEthernet извлекает список сетевых наборов, исключая Ethernet-сети. | |
| 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 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
- 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
- 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
- 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
- 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
- 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/oneview_network_set_info_module.html