os_port – Добавление/обновление/удаление портов из облака OpenStack

Новая версия 2.0.

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

Описание

Добавление, обновление или удаление портов из облака OpenStack. Состояние «present» гарантирует создание или обновление порта при необходимости.

Требования

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

python >= 2.7
openstacksdk

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
admin_state_up boolean	Варианты: no yes	Устанавливает административное состояние.
allowed_address_pairs -		Список разрешенных пар адресов. Разрешенные пары адресов поддерживаются со структурой словаря. Например, allowed_address_pairs: - ip_address: 10.1.0.12 mac_address: ab:cd:ef:12:34:56 - ip_address: ...
api_timeout integer		Сколько времени должна ждать транспортный слой, прежде чем истечет время ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку requests.
auth dictionary		Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_project_domain_name), если их поддерживает облако. Для других подключаемых модулей этот параметр должен содержать необходимые параметры. Этот параметр не нужен, если предоставлено имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type string		Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме парольной авторизации, имя подключаемого модуля должно быть указано здесь, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone -		Игнорируется. Присутствует для обратной совместимости.
ca_cert string		Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. псевдонимы: cacert
client_cert string		Путь к клиенту сертификату для использования в рамках транзакции SSL. псевдонимы: cert
client_key string		Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key
cloud raw		Именованное облако или конфигурация облака для работы. Если cloud является строкой, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, как в секции clouds.yaml.
device_id -		Идентификатор устройства, использующего этот порт.
device_owner -		Идентификатор сущности, использующей этот порт.
extra_dhcp_opts -		Дополнительные параметры dhcp для назначения этому порту. Дополнительные параметры поддерживаются со структурой словаря. Например, extra_dhcp_opts: - opt_name: opt name1 opt_value: value1 - opt_name: ...
fixed_ips -		Желаемый IP-адрес и/или подсеть для этого порта. Подсеть указывается по subnet_id, а IP-адрес по ip_address.
interface string добавлен в 2.3	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога сервиса. псевдонимы: endpoint_type
mac_address -		MAC-адрес этого порта.
name -		Имя, которое должно быть присвоено порту.
network - / обязательно		Идентификатор или имя сети, к которой принадлежит этот порт.
no_security_groups boolean	Варианты: no ← yes	Не ассоциировать группу безопасности с этим портом.
port_security_enabled boolean добавлен в 2.8	Варианты: no yes	Включить или отключить безопасность порта в сети.
region_name string		Имя региона.
security_groups -		Идентификаторы или имена групп безопасности, ассоциированные с портом (строка, разделенная запятыми или список YAML).
state -	Варианты: present ← absent	Ресурс должен быть присутствующим или отсутствующим.
timeout integer	Значение по умолчанию: 180	Сколько времени Ansible должно ждать запрашиваемого ресурса.
validate_certs boolean	Варианты: no ← yes	Проверять запросы API SSL или нет. До Ansible 2.3 это имело значение по умолчанию `yes`. псевдонимы: verify
vnic_type - добавлен в 2.8	Варианты: normal direct direct-physical macvtap baremetal virtio-forwarder	Тип порта, который необходимо создать.
wait boolean	Варианты: no yes ←	Должен ли Ansible ждать, пока запрашиваемый ресурс завершит работу.

Примечания

Примечание

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

Примеры

# Create a port
- os_port:
    state: present
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: port1
    network: foo

# Create a port with a static IP
- os_port:
    state: present
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: port1
    network: foo
    fixed_ips:
      - ip_address: 10.1.0.21

# Create a port with No security groups
- os_port:
    state: present
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: port1
    network: foo
    no_security_groups: True

# Update the existing 'port1' port with multiple security groups (version 1)
- os_port:
    state: present
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: port1
    security_groups: 1496e8c7-4918-482a-9172-f4f00fc4a3a5,057d4bdf-6d4d-472...

# Update the existing 'port1' port with multiple security groups (version 2)
- os_port:
    state: present
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: port1
    security_groups:
      - 1496e8c7-4918-482a-9172-f4f00fc4a3a5
      - 057d4bdf-6d4d-472...

# Create port of type 'direct'
- os_port:
    state: present
    auth:
      auth_url: https://identity.example.com
      username: admin
      password: admin
      project_name: admin
    name: port1
    vnic_type: direct

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

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

Ключ	Возвращаемое значение	Описание
admin_state_up boolean	успех	Флаг состояния управления администратором для этого порта.
allowed_address_pairs список	успех	Разрешённые пары адресов с этим портом.
fixed_ips список	успех	Фиксированный(ые) IP-адрес(ы), связанные с этим портом.
id строка	успех	Уникальный UUID.
name строка	успех	Имя, присвоенное порту.
network_id строка	успех	ID сети, к которой принадлежит этот порт.
port_security_enabled boolean	успех	Состояние защиты порта в сети.
security_groups список	успех	Группа(ы) безопасности, связанные с этим портом.
status строка	успех	Статус порта.
tenant_id строка	успех	ID арендатора, связанного с этим портом.
vnic_type строка	успех	Тип созданного порта

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Davide Agnello (@dagnello)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/os_port_module.html