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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 path добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, который будет использоваться для проверки.
fabric_id string	Уникальный идентификатор фабрики. fabric_id и fabric_name являются взаимоисключающими параметрами.
fabric_name string	Уникальное имя фабрики. fabric_name и fabric_id являются взаимоисключающими параметрами.
hostname string / обязательный	IP-адрес или имя хоста OpenManage Enterprise Modular.
password string	Пароль OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port integer	HTTPS-порт OpenManage Enterprise Modular. По умолчанию: `443`
timeout integer добавлено в dellemc.openmanage 5.0.0	Тайм-аут на уровне сокета в секундах. По умолчанию: `30`
uplink_id string	Уникальный идентификатор аплинка. uplink_id и uplink_name являются взаимоисключающими параметрами. Вместе с uplink_id необходимо указать fabric_id или fabric_name.
uplink_name string	Уникальное имя аплинка. uplink_name и uplink_id являются взаимоисключающими параметрами. Вместе с uplink_name необходимо указать fabric_id или fabric_name.
username string	Имя пользователя OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная среды `OME_USERNAME`. Пример: export OME_USERNAME=username
validate_certs boolean добавлено в dellemc.openmanage 5.0.0	Если значение `false`, SSL-сертификаты не будут проверяться. Настраивайте `false` только на объектах под личным контролем, где используются самоподписанные сертификаты. До версии коллекции `5.0.0` параметр validate_certs по умолчанию `false`. Варианты: `false` `true` ← (по умолчанию)
x_auth_token string добавлено в 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 dictionary	Сведения об ошибке 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 string	Статус получения сведений об аплинке фабрики. Возвращается: всегда Пример: `"Successfully retrieved the fabric uplink information."`
uplink_info list / elements=string	Сведения об аплинке фабрики. Возвращается: при успешном выполнении Пример: [{"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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/openmanage/ome_smart_fabric_uplink_info_module.html