Модуль community.general.oneview_fcoe_network – Управление ресурсами сети FCoE в OneView

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

Чтобы использовать его в playbook, укажите: community.general.oneview_fcoe_network.

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

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

Обеспечивает интерфейс для управления ресурсами сети FCoE. Может создавать, обновлять или удалять.

Требования

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

Python >= 2.7.9
hpOneView >= 4.0.0

Параметры

Параметр	Комментарии
api_version integer	Версия API OneView.
config path	Путь к JSON-файлу конфигурации, содержащему конфигурацию клиента OneView. Файл конфигурации является необязательным, и при использовании он должен присутствовать на хосте, выполняющем команды Ansible. Если путь к файлу не указан, конфигурация будет загружена из переменных среды. Для ссылок на примеры файлов конфигурации или инструкции по использованию переменных среды проверьте раздел «Примечания».
data dictionary / required	Список со свойствами сети FCoE.
hostname string	IP-адрес или имя хоста для устройства.
image_streamer_hostname string	IP-адрес или имя хоста для REST API HPE Image Streamer.
password string	Пароль для аутентификации API.
state string	Указывает желаемое состояние ресурса сети FCoE. `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
Дополнительные Playbook для модулей 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 FCoE Network is present using the default configuration
  community.general.oneview_fcoe_network:
    config: '/etc/oneview/oneview_config.json'
    state: present
    data:
      name: Test FCoE Network
      vlanId: 201
  delegate_to: localhost

- name: Update the FCOE network scopes
  community.general.oneview_fcoe_network:
    config: '/etc/oneview/oneview_config.json'
    state: present
    data:
      name: New FCoE Network
      scopeUris:
        - '/rest/scopes/00SC123456'
        - '/rest/scopes/01SC123456'
  delegate_to: localhost

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

Значения возврата

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

Ключ	Описание
fcoe_network словарь	Содержит данные о сетях FCoE OneView. Возвращается: в состоянии ‘present’. Может быть пустым.

Авторы

Felipe Bulsoni (@fgbulsoni)

Ссылки на сборку

© 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_fcoe_network_module.html