Модуль community.general.oneview_ethernet_network — управление ресурсами сетей 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.

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

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

Предоставляет интерфейс для управления ресурсами сетей Ethernet. Позволяет создавать, обновлять и удалять ресурсы.

Требования

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

Python >= 2.7.9
hpOneView >= 3.1.0

Параметры

Параметр	Описание
api_version integer	Версия API OneView.
config path	Путь к файлу конфигурации JSON с настройками клиента OneView. Файл конфигурации необязателен; если он используется, он должен находиться на хосте, где выполняются команды Ansible. Если путь к файлу не указан, конфигурация загружается из переменных среды. Ссылки на примеры файлов конфигурации и сведения об использовании переменных среды см. в разделе примечаний.
data dictionary / обязательный	Список свойств сети Ethernet.
hostname string	IP-адрес или имя хоста устройства.
image_streamer_hostname string	IP-адрес или имя хоста REST API HPE Image Streamer.
password string	Пароль для аутентификации в API.
state string	Желаемое состояние ресурса сети Ethernet. `present` гарантирует соответствие свойств данных требованиям OneView. `absent` удаляет ресурс из OneView, если он существует. `default_bandwidth_reset` сбрасывает шаблон подключения сети до значения по умолчанию. Варианты: `"present"` ← (по умолчанию) `"absent"` `"default_bandwidth_reset"`
username string	Имя пользователя для аутентификации в API.
validate_etag boolean	Если проверка ETag включена, запрос обрабатывается только в том случае, если текущий ETag ресурса совпадает с ETag, указанным в данных. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может работать в режиме `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: Ensure that the Ethernet Network is present using the default configuration
  community.general.oneview_ethernet_network:
    config: '/etc/oneview/oneview_config.json'
    state: present
    data:
      name: 'Test Ethernet Network'
      vlanId: '201'
  delegate_to: localhost

- name: Update the Ethernet Network changing bandwidth and purpose
  community.general.oneview_ethernet_network:
    config: '/etc/oneview/oneview_config.json'
    state: present
    data:
      name: 'Test Ethernet Network'
      purpose: Management
      bandwidth:
        maximumBandwidth: 3000
        typicalBandwidth: 2000
  delegate_to: localhost

- name: Ensure that the Ethernet Network is present with name 'Renamed Ethernet Network'
  community.general.oneview_ethernet_network:
    config: '/etc/oneview/oneview_config.json'
    state: present
    data:
      name: 'Test Ethernet Network'
      newName: 'Renamed Ethernet Network'
  delegate_to: localhost

- name: Ensure that the Ethernet Network is absent
  community.general.oneview_ethernet_network:
    config: '/etc/oneview/oneview_config.json'
    state: absent
    data:
      name: 'New Ethernet Network'
  delegate_to: localhost

- name: Create Ethernet networks in bulk
  community.general.oneview_ethernet_network:
    config: '/etc/oneview/oneview_config.json'
    state: present
    data:
      vlanIdRange: '1-10,15,17'
      purpose: General
      namePrefix: TestNetwork
      smartLink: false
      privateNetwork: false
      bandwidth:
        maximumBandwidth: 10000
        typicalBandwidth: 2000
  delegate_to: localhost

- name: Reset to the default network connection template
  community.general.oneview_ethernet_network:
    config: '/etc/oneview/oneview_config.json'
    state: default_bandwidth_reset
    data:
      name: 'Test Ethernet Network'
  delegate_to: localhost

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

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

Ключ	Описание
ethernet_network dictionary	Содержит сведения о сетях Ethernet. Возвращается: При `state=present`. Может иметь значение null.
ethernet_network_bulk dictionary	Содержит сведения о сетях Ethernet, затронутых массовой вставкой. Возвращается: Если атрибут `vlanIdRange` указан в аргументе `data`. Может иметь значение null.
ethernet_network_connection_template dictionary	Содержит сведения о шаблоне подключения сети Ethernet. Возвращается: При `state=default_bandwidth_reset`. Может иметь значение 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_module.html