os_port – Добавление/обновление/удаление портов из облака OpenStack.
Новая версия с 2.0.
Описание
- Добавить, обновить или удалить порты из облака OpenStack. Состояние state ‘present’ обеспечит создание или обновление порта при необходимости.
Требования
Ниже приведены требования к хосту, на котором выполняется данный модуль.
- python >= 2.7
- openstacksdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| admin_state_up - | Устанавливает административное состояние. | |
| allowed_address_pairs - | Список разрешённых пар адресов. Разрешённые пары адресов поддерживаются со структурой словаря. Например: allowed_address_pairs: - ip_address: 10.1.0.12 mac_address: ab:cd:ef:12:34:56 - ip_address: ... | |
| api_timeout - | Сколько времени слой сокета должен ждать перед истечением времени ожидания для API-вызовов. Если это опущено, ничего не будет передано библиотеке requests. | |
| auth - | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password, это будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type - | Имя плагина авторизации для использования. Если облако использует что-то помимо парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответственно обновлено. | |
| availability_zone - | Игнорируется. Присутствует для обратной совместимости | |
| cacert - | Путь к пакету сертификатов CA, который может быть использован для проверки SSL-запросов API. | |
| cert - | Путь к клиентскому сертификату для использования в рамках транзакции SSL. | |
| cloud - | Наименованное облако или конфигурация облака для работы. Если 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 - добавлено в 2.3 |
| Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| key - | Путь к клиентскому ключу для использования в рамках транзакции SSL. | |
| mac_address - | MAC-адрес этого порта. | |
| name - | Название, которое нужно присвоить порту. | |
| network - / обязательно | Идентификатор или имя сети, к которой принадлежит этот порт. | |
| no_security_groups - | Значение по умолчанию: "нет" | Не ассоциировать группу безопасности с этим портом. |
| region_name - | Имя региона. | |
| security_groups - | Идентификатор(ы) или имя(на) группы(ы) безопасности, связанные с портом (строка, разделённая запятыми, или список YAML) | |
| state - |
| Ресурс должен быть присутствовать или отсутствовать. |
| timeout - | Значение по умолчанию: 180 | Сколько времени Ansible должен ждать запрошенного ресурса. |
| verify boolean |
| Нужно ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait boolean |
| Должен ли Ansible ждать завершения запрошенного ресурса. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и, наконец, из явных параметров в play. Более подробную информацию можно найти на http://docs.openstack.org/developer/os-client-config
Примеры
# 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...
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| admin_state_up boolean | успех | Флаг административного состояния вверх для этого порта. |
| allowed_address_pairs список | успех | Разрешённые пары адресов с этим портом. |
| fixed_ips список | успех | Фиксированный(ые) IP-адрес(ы), связанные с этим портом. |
| id строка | успех | Уникальный UUID. |
| name строка | успех | Название, присвоенное порту. |
| network_id строка | успех | Идентификатор сети, в которой находится этот порт. |
| security_groups список | успех | Группа(ы) безопасности, связанные с этим портом. |
| status строка | успех | Состояние порта. |
| tenant_id строка | успех | Идентификатор арендатора, связанный с этим портом. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом 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.7/modules/os_port_module.html
