Spec-Zone.ru › Ansible

Модуль openstack.cloud.baremetal_port_info — получение сведений о bare-metal-портах из OpenStack

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).

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

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

Чтобы использовать модуль в сценарии, укажите: openstack.cloud.baremetal_port_info.

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

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

  • Получение сведений о bare-metal-портах из OpenStack.

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

address

string

Физический аппаратный адрес этого сетевого порта, обычно MAC-адрес устройства.

api_timeout

integer

Время ожидания на уровне сокета перед истечением времени ожидания вызова API. Если параметр не указан, библиотеке requests ничего не передаётся.

auth

dictionary

Словарь с данными аутентификации, необходимыми для выбранной стратегии плагина аутентификации облака. Для используемого по умолчанию плагина password здесь указываются auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все параметры, необходимые соответствующему плагину аутентификации. Этот параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*.

auth_type

string

Имя используемого плагина аутентификации. Если облако использует не аутентификацию по паролю, здесь следует указать имя плагина и соответствующим образом изменить содержимое параметра auth.

ca_cert

псевдонимы: cacert

string

Путь к набору сертификатов ЦС, который можно использовать для проверки запросов к API через SSL.

client_cert

псевдонимы: cert

string

Путь к клиентскому сертификату, используемому при обмене данными через SSL.

client_key

псевдонимы: key

string

Путь к клиентскому ключу, используемому при обмене данными через SSL.

cloud

any

Именованное облако или конфигурация облака, с которыми выполняются операции. Если cloud — это строка, она задаёт именованную конфигурацию облака из файла OpenStack clouds.yaml. Параметр предоставляет значения по умолчанию для auth и auth_type. Он не требуется, если задан auth или присутствуют переменные среды OpenStack OS_*. Если cloud — это словарь, он содержит полную конфигурацию облака, аналогичную разделу в clouds.yaml.

interface

псевдонимы: endpoint_type

string

Тип URL конечной точки, получаемой из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

name

псевдонимы: uuid

string

Имя или идентификатор bare-metal-порта.

node

string

Имя или идентификатор bare-metal-узла.

region_name

string

Имя региона.

sdk_log_level

string

Уровень журналирования OpenStackSDK

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

string

Путь к файлу журнала OpenStackSDK. Если значение не задано, журнал не записывается.

timeout

integer

Время ожидания Ansible запрошенного ресурса.

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

validate_certs

псевдонимы: verify

boolean

Следует ли проверять запросы к API через SSL.

До Ansible 2.3 значение по умолчанию было true.

Варианты:

  • false
  • true

wait

boolean

Должен ли Ansible ожидать завершения работы с запрошенным ресурсом.

Варианты:

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

Примечания

Примечание

  • Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например OS_USERNAME.
  • Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явно заданных параметров сценариев. Дополнительные сведения см. на странице https://docs.openstack.org/openstacksdk/

Примеры

- name: Gather information about all baremetal ports
  openstack.cloud.baremetal_port_info:
    cloud: devstack

- name: Gather information about a baremetal port by address
  openstack.cloud.baremetal_port_info:
    cloud: devstack
    address: fa:16:3e:aa:aa:aa

- name: Gather information about a baremetal port by address
  openstack.cloud.baremetal_port_info:
    cloud: devstack
    name: a2b6bd99-77b9-43f0-9ddc-826568e68dec

- name: Gather information about a baremetal ports associated with a node
  openstack.cloud.baremetal_port_info:
    cloud: devstack
    node: bm-0

Возвращаемые значения

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

Ключ

Описание

ports

list / elements=dictionary

Список bare-metal-портов.

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

address

string

Физический аппаратный адрес этого сетевого порта, обычно MAC-адрес устройства.

Возвращается: при успешном выполнении

created_at

string

Метка времени создания bare-metal-порта.

Возвращается: при успешном выполнении

extra

dictionary

Один или несколько произвольных пар «ключ — значение» метаданных.

Возвращается: при успешном выполнении

id

string

UUID ресурса bare-metal-порта.

Возвращается: при успешном выполнении

internal_info

dictionary

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

Возвращается: при успешном выполнении

is_pxe_enabled

boolean

Включена ли поддержка PXE на порте.

Возвращается: при успешном выполнении

links

list / elements=string

Список относительных ссылок, включая ссылки на ресурс и закладку.

Возвращается: при успешном выполнении

local_link_connection

dictionary

Профиль привязки порта.

Возвращается: при успешном выполнении

port_id

string

Идентификатор физического порта коммутатора, к которому подключён порт узла.

Возвращается: при успешном выполнении

switch_id

string

MAC-адрес коммутатора или его datapath_id на основе OpenFlow.

Возвращается: при успешном выполнении

switch_info

string

Необязательное строковое поле для хранения сведений, специфичных для производителя.

Возвращается: при успешном выполнении

location

dictionary

Расположение этого ресурса в облаке (облако, проект, регион, зона)

Возвращается: при успешном выполнении

name

string

Имя bare-metal-порта.

Возвращается: при успешном выполнении

node_id

string

UUID bare-metal-узла, которому принадлежит этот ресурс.

Возвращается: при успешном выполнении

physical_network

string

Имя физической сети, к которой подключён порт.

Возвращается: при успешном выполнении

port_group_id

string

UUID группы портов, которой принадлежит этот ресурс.

Возвращается: при успешном выполнении

updated_at

string

Метка времени последнего обновления bare-metal-порта.

Возвращается: при успешном выполнении

Авторы

  • Группа специальных интересов OpenStack Ansible

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

  • Отслеживание ошибок
  • Репозиторий (исходный код)

© 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/openstack/cloud/baremetal_port_info_module.html

Spec-Zone.ru

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