Модуль community.general.oneview_fc_network – Управление ресурсами сети Fibre Channel в OneView
Примечание
Этот модуль является частью коллекции community.general (версия 9.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, запустите ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.general. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.
Чтобы использовать его в playbook, укажите: community.general.oneview_fc_network.
Краткое описание
- Предоставляет интерфейс для управления ресурсами сети Fibre Channel. Может создавать, обновлять и удалять.
Требования
Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.
- Python >= 2.7.9
- hpOneView >= 4.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_version integer | Версия API OneView. |
config path | Путь к JSON-файлу конфигурации, содержащему конфигурацию клиента OneView. Файл конфигурации является необязательным, и при его использовании он должен присутствовать на хосте, выполняющем команды Ansible. Если путь к файлу не указан, конфигурация будет загружена из переменных среды. Для ссылок на примеры файлов конфигурации или на то, как использовать переменные среды, см. раздел «Примечания». |
data dictionary / required | Список со свойствами сети Fibre Channel. |
hostname string | IP-адрес или имя хоста устройства. |
image_streamer_hostname string | IP-адрес или имя хоста REST API HPE Image Streamer. |
password string | Пароль для аутентификации API. |
state string / required | Указывает желаемое состояние ресурса сети Fibre Channel. Варианты:
|
username string | Имя пользователя для аутентификации API. |
validate_etag boolean | Когда включена проверка ETag, запрос будет обрабатываться условно только в том случае, если текущий ETag для ресурса соответствует ETag, указанному в данных. Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: отсутствует | Может работать в режиме |
diff_mode | Поддержка: отсутствует | Будет возвращать подробную информацию о том, что изменилось (или, возможно, нуждается в изменении в |
Примечания
Примечание
- Пример файла конфигурации для параметра config можно найти по адресу: https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json
- Информацию о том, как использовать переменные среды для конфигурации, см. по адресу: https://github.com/HewlettPackard/oneview-ansible#environment-variables
- Дополнительные Playbook для модулей 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 Fibre Channel Network is present using the default configuration
community.general.oneview_fc_network:
config: "{{ config_file_path }}"
state: present
data:
name: 'New FC Network'
- name: Ensure that the Fibre Channel Network is present with fabricType 'DirectAttach'
community.general.oneview_fc_network:
config: "{{ config_file_path }}"
state: present
data:
name: 'New FC Network'
fabricType: 'DirectAttach'
- name: Ensure that the Fibre Channel Network is present and is inserted in the desired scopes
community.general.oneview_fc_network:
config: "{{ config_file_path }}"
state: present
data:
name: 'New FC Network'
scopeUris:
- '/rest/scopes/00SC123456'
- '/rest/scopes/01SC123456'
- name: Ensure that the Fibre Channel Network is absent
community.general.oneview_fc_network:
config: "{{ config_file_path }}"
state: absent
data:
name: 'New FC Network'
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
fc_network словарь | Содержит данные о управляемой сети FC OneView. Возвращаемое значение: При состоянии ‘present’. Может быть равно null. |
Ссылки на сборку
© 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_fc_network_module.html