Модуль community.general.oneview_network_set — управление ресурсами наборов сетей HPE OneView

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.oneview_network_set.

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

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

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

Требования

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

Python >= 2.7.9
hpOneView >= 4.0.0

Параметры

Параметр	Комментарии
api_version integer	Версия API OneView.
config path	Путь к файлу конфигурации JSON с настройками клиента OneView. Файл конфигурации необязателен; если он используется, он должен находиться на хосте, где выполняются команды Ansible. Если путь к файлу не указан, конфигурация загружается из переменных окружения. Ссылки на примеры файлов конфигурации и сведения об использовании переменных окружения приведены в разделе примечаний.
data dictionary / обязательный	Список свойств набора сетей.
hostname string	IP-адрес или имя хоста устройства.
image_streamer_hostname string	IP-адрес или имя хоста REST API HPE Image Streamer.
password string	Пароль для аутентификации в API.
state string	Указывает требуемое состояние ресурса набора сетей. `present` обеспечивает соответствие свойств данных требованиям OneView. `absent` удаляет ресурс из OneView, если он существует. Варианты: `"present"` ← (по умолчанию) `"absent"`
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: Create a Network Set
  community.general.oneview_network_set:
    config: /etc/oneview/oneview_config.json
    state: present
    data:
      name: OneViewSDK Test Network Set
      networkUris:
        - Test Ethernet Network_1                                      # can be a name
        - /rest/ethernet-networks/e4360c9d-051d-4931-b2aa-7de846450dd8 # or a URI
  delegate_to: localhost

- name: Update the Network Set name to 'OneViewSDK Test Network Set - Renamed' and change the associated networks
  community.general.oneview_network_set:
    config: /etc/oneview/oneview_config.json
    state: present
    data:
      name: OneViewSDK Test Network Set
      newName: OneViewSDK Test Network Set - Renamed
      networkUris:
        - Test Ethernet Network_1
  delegate_to: localhost

- name: Delete the Network Set
  community.general.oneview_network_set:
    config: /etc/oneview/oneview_config.json
    state: absent
    data:
      name: OneViewSDK Test Network Set - Renamed
  delegate_to: localhost

- name: Update the Network set with two scopes
  community.general.oneview_network_set:
    config: /etc/oneview/oneview_config.json
    state: present
    data:
      name: OneViewSDK Test Network Set
      scopeUris:
        - /rest/scopes/01SC123456
        - /rest/scopes/02SC123456
  delegate_to: localhost

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

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

Ключ	Описание
network_set dictionary	Содержит сведения о наборе сетей. Возвращается: при `state=present`, но может иметь значение 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_network_set_module.html