Spec-Zone.ru › Ansible

Модуль openstack.cloud.baremetal_port – создание и удаление ресурсов портов 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.

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

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

  • Создание, обновление и удаление портов ironic в 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

Путь к пакету сертификатов CA, который можно использовать для проверки запросов 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.

extra

dictionary

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

id

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

string

Идентификатор порта.

Будет сгенерирован автоматически, если не указан.

interface

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

string

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

Варианты:

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

is_pxe_enabled

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

boolean

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

Варианты:

  • false
  • true

local_link_connection

dictionary

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

port_id

string

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

switch_id

string

MAC-адрес коммутатора или идентификатор его канала передачи данных на основе OpenFlow (datapath_id).

switch_info

string

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

node

string

Идентификатор или имя узла, которому принадлежит этот ресурс.

physical_network

string

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

port_group

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

string

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

region_name

string

Имя региона.

sdk_log_level

string

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

Варианты:

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

sdk_log_path

string

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

state

string

Задает требуемое состояние ресурса.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

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: Create Bare Metal port
  openstack.cloud.baremetal_port:
    cloud: devstack
    state: present
    node: bm-0
    address: fa:16:3e:aa:aa:aa
    is_pxe_enabled: True
    local_link_connection:
      switch_id: 0a:1b:2c:3d:4e:5f
      port_id: Ethernet3/1
      switch_info: switch1
    extra:
      something: extra
    physical_network: datacenter
  register: result

- name: Delete Bare Metal port
  openstack.cloud.baremetal_port:
    cloud: devstack
    state: absent
    address: fa:16:3e:aa:aa:aa
  register: result

- name: Update Bare Metal port
  openstack.cloud.baremetal_port:
    cloud: devstack
    state: present
    id: 1a85ebca-22bf-42eb-ad9e-f640789b8098
    is_pxe_enabled: False
    local_link_connection:
      switch_id: a0:b1:c2:d3:e4:f5
      port_id: Ethernet4/12
      switch_info: switch2

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

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

Ключ

Описание

port

dictionary

Словарь порта. В зависимости от поставщика облачных услуг может возвращаться подмножество перечисленных ниже ключей словаря.

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

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 / элементы=string

Список относительных ссылок, включая ссылки self и bookmark.

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

local_link_connection

dictionary

Профиль привязки порта. Если он задан, должен содержать поля switch_id (в этом поле допускаются только MAC-адрес коммутатора или его идентификатор канала передачи данных на основе OpenFlow (datapath_id)) и port_id (идентификатор физического порта на коммутаторе, к которому подключен порт узла). switch_info — необязательное строковое поле для хранения информации, специфичной для производителя.

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

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–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_module.html

Spec-Zone.ru

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