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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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	Поддержка: отсутствует	В режиме сравнения вернёт подробности о том, что изменилось (или, возможно, требует изменения в `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 словарь	Содержит сведения о сетевом наборе. Возвращается: в состоянии ‘present’, но может быть 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_network_set_module.html