openstack.cloud.baremetal_port_info модуль – Получение информации о портах Bare Metal из OpenStack

Примечание

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

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

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

Для использования в playbook укажите: openstack.cloud.baremetal_port_info.

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

Обзор

Получение информации о портах Bare Metal из OpenStack.

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
address строка	Физический адрес этого сетевого порта, обычно аппаратный MAC-адрес.
api_timeout целое число	Сколько времени должна ждать транспортный уровень, прежде чем истечёт время ожидания для вызовов API. Если это значение опущено, ничего не будет передано в библиотеку запросов.
auth словарь	Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password, он будет содержать auth_url, username, password, project_name и любые данные о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать требуемые параметры подключаемого модуля авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type строка	Имя подключаемого модуля авторизации для использования. Если облако использует что-то помимо парольной авторизации, имя подключаемого модуля должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено.
ca_cert псевдонимы: cacert строка	Путь к пакету сертификата CA, который может использоваться для проверки запросов API SSL.
client_cert псевдонимы: cert строка	Путь к клиенту сертификату для использования в рамках транзакции SSL.
client_key псевдонимы: key строка	Путь к ключу клиента для использования в рамках транзакции SSL.
cloud любой тип	Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, как в секции clouds.yaml.
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name псевдонимы: uuid строка	Имя или идентификатор порта Bare Metal.
node строка	Имя или идентификатор узла Bare Metal.
region_name строка	Название региона.
sdk_log_level строка	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается
timeout целое число	Сколько времени Ansible должно ждать запрошенного ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify булево	Должны ли проверяться запросы API SSL. До Ansible 2.3 это по умолчанию было `true`. Варианты: `false` `true`
wait булево	Должен ли 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 для ресурса порта Baremetal. Возвращается: при успехе
internal_info dictionary	Внутренние метаданные, установленные и хранящиеся портом. Это поле доступно только для чтения. Возвращается: при успехе
is_pxe_enabled boolean	Включен или выключен PXE на порту. Возвращается: при успехе
links list / elements=string	Список относительных ссылок, включая ссылки self и bookmark. Возвращается: при успехе
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 SIG

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

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