Модуль community.general.oneview_ethernet_network_info – Получение информации об одной или нескольких сетях Ethernet OneView
Примечание
Этот модуль является частью коллекции community.general (версия 9.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.
Для использования в playbook, укажите: 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 и связанных ресурсах. Допустимые параметры: |
params dictionary | Список параметров для ограничения, фильтрации и сортировки списка ресурсов. Допустимые ключи параметров:
|
password string | Пароль для аутентификации API. |
username string | Имя пользователя для аутентификации API. |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная добавлено в community.general 3.3.0 Это действие не изменяет состояние. | Может работать в режиме |
diff_mode | Поддержка: Н/Д Это действие не изменяет состояние. | В режиме diff вернет подробную информацию о том, что изменилось (или, возможно, должно быть изменено в |
Примечания
Примечание
- Пример файла конфигурации для параметра config можно найти по адресу: https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json
- Информацию о том, как использовать переменные среды для конфигурации, можно найти по адресу: https://github.com/HewlettPackard/oneview-ansible#environment-variables
- Дополнительные Playbook для модулей 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 словарь | Содержит всю информацию OneView о профилях, использующих Ethernet-сеть. Возвращается: При запросе, но может быть пустым. |
enet_associated_uplink_groups словарь | Содержит всю информацию OneView о группах Uplink, которые используют Ethernet-сеть. Возвращается: При запросе, но может быть пустым. |
ethernet_networks словарь | Содержит всю информацию OneView об Ethernet-сетях. Возвращается: Всегда, но может быть пустым. |
Ссылки на коллекцию
© 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_ethernet_network_info_module.html
