Spec-Zone.ru › Ansible

Модуль dellemc.openmanage.ome_smart_fabric_uplink_info — Получение данных о соединении фабрики в OpenManage Enterprise Modular.

Примечание

Этот модуль входит в состав коллекции dellemc.openmanage (версия 9.7.0).

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

Для установки используйте: ansible-galaxy collection install dellemc.openmanage. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в книге задач укажите: dellemc.openmanage.ome_smart_fabric_uplink_info.

Добавлена в dellemc.openmanage 7.1.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Этот модуль получает данные о соединении фабрики в OpenManage Enterprise Modular.

Требования

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

  • python >= 3.9.6

Параметры

Параметр

Комментарии

ca_path

путь

добавлено в dellemc.openmanage 5.0.0

Файл PEM (Privacy Enhanced Mail) с сертификатом CA, используемым для проверки.

fabric_id

строка

Уникальный идентификатор фабрики.

fabric_id взаимно исключает fabric_name.

fabric_name

строка

Уникальное имя фабрики.

fabric_name взаимно исключает fabric_id.

hostname

строка / обязательно

IP-адрес или имя хоста OpenManage Enterprise Modular.

password

строка

Пароль OpenManage Enterprise Modular.

Если пароль не указан, используется переменная среды OME_PASSWORD.

Пример: export OME_PASSWORD=пароль

port

целое число

Порт HTTPS OpenManage Enterprise Modular.

По умолчанию: 443

timeout

целое число

добавлено в dellemc.openmanage 5.0.0

Таймаут уровня сокета в секундах.

По умолчанию: 30

uplink_id

строка

Уникальный идентификатор соединения.

uplink_id взаимно исключает uplink_name.

fabric_id или fabric_name требуется вместе с uplink_id.

uplink_name

строка

Уникальное имя соединения.

uplink_name взаимно исключает uplink_id.

fabric_id или fabric_name требуется вместе с uplink_name.

username

строка

Имя пользователя OpenManage Enterprise Modular.

Если имя пользователя не указано, используется переменная среды OME_USERNAME.

Пример: export OME_USERNAME=имя_пользователя

validate_certs

логическое

добавлено в dellemc.openmanage 5.0.0

Если false, сертификаты SSL не будут проверены.

Настраивайте false только на контролируемых вами сайтах, где используются самозаверяемые сертификаты.

До версии коллекции 5.0.0, validate_certs был false по умолчанию.

Выбираемые значения:

  • false
  • true ← (по умолчанию)

x_auth_token

строка

добавлено в dellemc.openmanage 9.3.0

Токен аутентификации.

Если x_auth_token не указан, используется переменная среды OME_X_AUTH_TOKEN.

Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

  • Выполняйте этот модуль с системы, имеющей прямой доступ к Dell OpenManage Enterprise Modular.
  • Этот модуль поддерживает check_mode.

Примеры

---
- name: Retrieve all fabric uplink information using fabric_id.
  dellemc.openmanage.ome_smart_fabric_uplink_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fabric_id: "61c20a59-9ed5-4ae5-b850-5e5acf42d2f2"

- name: Retrieve all fabric uplink information using fabric_name.
  dellemc.openmanage.ome_smart_fabric_uplink_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fabric_name: "f1"

- name: Retrieve specific fabric information using uplink_id.
  dellemc.openmanage.ome_smart_fabric_uplink_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fabric_id: "61c20a59-9ed5-4ae5-b850-5e5acf42d2f2"
    uplink_id: "1ad54420-b145-49a1-9779-21a579ef6f2d"

- name: Retrieve specific fabric information using uplink_name.
  dellemc.openmanage.ome_smart_fabric_uplink_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fabric_id: "61c20a59-9ed5-4ae5-b850-5e5acf42d2f2"
    uplink_name: "u1"

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

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

Ключ

Описание

error_info

словарь

Подробности HTTP-ошибки.

Возвращается: при HTTP-ошибке

Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to complete the request because the resource URI does not exist or is not implemented.", "MessageArgs": [], "MessageId": "CGEN1006", "RelatedProperties": [], "Resolution": "Check the request resource URI. Refer to the OpenManage Enterprise-Modular User's Guide for more information about resource URI and its properties.", "Severity": "Critical"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}

msg

строка

Статус получения информации о Fabric uplink.

Возвращается: всегда

Пример: "Successfully retrieved the fabric uplink information."

uplink_info

список / элементы=строка

Информация о Fabric uplink.

Возвращается: при успехе

Пример: [{"Description": "", "Id": "1ad54420-b145-49a1-9779-21a579ef6f2d", "MediaType": "Ethernet", "Name": "u1", "NativeVLAN": 1, "Networks": [{"CreatedBy": "system", "CreationTime": "2018-09-25 14:46:12.374", "Description": null, "Id": 10155, "InternalRefNWUUId": "f15a36b6-e3d3-46b2-9e7d-bf9cd66e180d", "Name": "testvlan", "Type": 1, "UpdatedBy": "root", "UpdatedTime": "2019-06-27 15:06:22.836", "VlanMaximum": 143, "VlanMinimum": 143}], "Ports": [{"AdminStatus": "Enabled", "BlinkStatus": "OFF", "ConfiguredSpeed": "0", "CurrentSpeed": "0", "Description": "", "Id": "SVCTAG1:ethernet1/1/35", "MaxSpeed": "0", "MediaType": "Ethernet", "Name": "", "NodeServiceTag": "SVCTAG1", "OpticsType": "NotPresent", "PortNumber": "ethernet1/1/35", "Role": "Uplink", "Status": "Down", "Type": "PhysicalEthernet"}, {"AdminStatus": "Enabled", "BlinkStatus": "OFF", "ConfiguredSpeed": "0", "CurrentSpeed": "0", "Description": "", "Id": "SVCTAG1:ethernet1/1/35", "MaxSpeed": "0", "MediaType": "Ethernet", "Name": "", "NodeServiceTag": "SVCTAG1", "OpticsType": "NotPresent", "PortNumber": "ethernet1/1/35", "Role": "Uplink", "Status": "Down", "Type": "PhysicalEthernet"}], "Summary": {"NetworkCount": 1, "PortCount": 2}, "UfdEnable": "Disabled"}]

Авторы

  • Husniya Hameed(@husniya_hameed)

Ссылки на коллекцию

  • Система отслеживания задач
  • Главная страница
  • Репозиторий (исходные файлы)

© 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/dellemc/openmanage/ome_smart_fabric_uplink_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API