Модуль community.general.oneview_ethernet_network — Управление ресурсами сети Ethernet OneView

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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 целое число	Версия API OneView.
config путь	Путь к файлу конфигурации JSON, содержащему конфигурацию клиента OneView. Файл конфигурации необязателен и, при использовании, должен быть доступен на хосте, на котором выполняются команды Ansible. Если путь к файлу не указан, конфигурация загружается из переменных окружения. Ссылки на примеры файлов конфигурации или информацию о использовании переменных окружения см. в разделе «Примечания».
data словарь / обязательно	Список свойств сети Ethernet.
hostname строка	IP-адрес или имя хоста устройства.
image_streamer_hostname строка	IP-адрес или имя хоста REST API HPE Image Streamer.
password строка	Пароль для аутентификации API.
state строка	Указывает желаемое состояние ресурса сети Ethernet. - `present` гарантирует, что свойства данных соответствуют OneView. - `absent` удалит ресурс из OneView, если он существует. - `default_bandwidth_reset` сбросит шаблон конфигурации сети до значения по умолчанию. Варианты: `"present"` ← (по умолчанию) `"absent"` `"default_bandwidth_reset"`
username строка	Имя пользователя для аутентификации API.
validate_etag логическое значение	При включенной проверке ETag запрос будет обработать только в том случае, если текущий ETag ресурса соответствует ETag, предоставленному в данных. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может работать в режиме `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
Дополнительные книги задач для модулей 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: 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 словарь	Содержит данные об Ethernet-сетях. Возвращается: при состоянии ‘present’. Может быть null.
ethernet_network_bulk словарь	Содержит данные об Ethernet-сетях, затронутых массовым вставлением. Возвращается: когда атрибут ‘vlanIdRange’ присутствует в аргументе данных. Может быть null.
ethernet_network_connection_template словарь	Содержит данные о шаблоне подключения Ethernet-сети. Возвращается: при состоянии ‘default_bandwidth_reset’. Может быть null.

Авторы

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