openstack.cloud.baremetal_port модуль — Создание/удаление ресурсов портов Bare Metal из OpenStack

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.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 строка	Физический адрес этого сетевого порта, обычно аппаратный MAC-адрес.
api_timeout целое число	Сколько времени должна ждать транспортная среда, прежде чем произойдет таймаут API-вызовов. Если это опущено, ничего не будет передано библиотеке requests.
auth словарь	Словарь, содержащий информацию об авторизации, необходимую для стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать параметры, необходимые этому подключаемому модулю авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type строка	Имя подключаемого модуля авторизации для использования. Если облако использует что-то отличное от парольной аутентификации, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
ca_cert aliases: cacert строка	Путь к набору сертификатов CA, который может использоваться при проверке запросов API SSL.
client_cert aliases: cert строка	Путь к клиенту сертификат для использования в рамках транзакции SSL.
client_key aliases: key строка	Путь к ключу клиента для использования в рамках транзакции SSL.
cloud любой	Именованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на конфигурацию именованного облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан параметр auth или переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, как это определено в секции clouds.yaml.
extra словарь	Набор одного или нескольких произвольных пар ключ-значение метаданных.
id aliases: uuid строка	Идентификатор порта. Будет сгенерирован автоматически, если не указан.
interface aliases: endpoint_type строка	Тип URL конечной точки для извлечения из каталога сервисов. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
is_pxe_enabled aliases: pxe_enabled булево	Включить или отключить PXE на порту. Варианты: `false` `true`
local_link_connection словарь	Профиль привязки порта.
port_id строка	Идентификатор физического порта на коммутаторе, к которому подключен порт узла.
switch_id строка	MAC-адрес или идентификатор datapath_id на основе OpenFlow коммутатора.
switch_info строка	Необязательное строковое поле для хранения любой информации, специфичной для поставщика.
node строка	Идентификатор или имя узла, к которому относится этот ресурс.
physical_network строка	Имя физической сети, к которой подключен порт.
port_group aliases: portgroup строка	Идентификатор или имя группы портов, к которой относится этот ресурс.
region_name строка	Имя региона.

sdk_log_level string	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается
state string	Указывает желаемое состояние ресурса Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Сколько времени Ansible должно ждать запрошенного ресурса. По умолчанию: `180`
validate_certs aliases: 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 словарь	Словарь порта, подмножество ключей словаря, перечисленных ниже, может быть возвращено в зависимости от вашего поставщика облачных услуг. Возвращается: успех
address строка	Физический адрес аппаратного обеспечения этого сетевого порта, как правило, MAC-адрес аппаратного обеспечения. Возвращается: успех
created_at строка	Отметка времени создания порта Bare Metal. Возвращается: успех
extra словарь	Набор одного или нескольких произвольных пар ключ-значение метаданных. Возвращается: успех
id строка	UUID для ресурса порта Baremetal. Возвращается: успех
internal_info словарь	Внутренний набор метаданных, устанавливаемый и хранящийся портом. Это поле только для чтения. Возвращается: успех
is_pxe_enabled булево	Включен или выключен PXE на порту. Возвращается: успех
links список / элементы=строка	Список относительных ссылок, включая ссылки self и bookmark. Возвращается: успех
local_link_connection словарь	Профиль привязки порта. Если указано, должно содержать поля switch_id (принимаются только MAC-адрес или datapath_id OpenFlow-подобного коммутатора в этом поле и port_id (идентификатор физического порта на коммутаторе, к которому подключен порт узла)) switch_info — необязательное строковое поле для хранения любой информации, специфичной для поставщика. Возвращается: успех
location словарь	Облачное расположение этого ресурса (облако, проект, регион, зона) Возвращается: успех
name строка	Название порта Bare Metal. Возвращается: успех
node_id строка	UUID узла Bare Metal, к которому относится этот ресурс. Возвращается: успех
physical_network строка	Имя физической сети, к которой подключен порт. Возвращается: успех
port_group_id строка	UUID группы портов, к которой относится этот ресурс. Возвращается: успех
updated_at строка	Отметка времени обновления порта 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_module.html