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. Если это опущено, ничего не будет передано в библиотеку запросов. | |
| 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 bool |
| Нужно ли проверять запросы SSL API. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| wait bool |
| Должен ли Ansible ждать, пока запрашиваемый ресурс не будет завершен. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла yaml-конфигурации в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения, и, наконец, явными параметрами в сценариях. Дополнительную информацию можно найти по адресу 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 bool | успех | Флаг состояния администратора для этого порта. |
| allowed_address_pairs список | успех | Разрешенные пары адресов с этим портом. |
| fixed_ips список | успех | Фиксированный(ые) IP-адрес(а) связанный(ые) с этим портом. |
| id строка | успех | Уникальный UUID. |
| name строка | успех | Имя, заданное порту. |
| network_id строка | успех | Идентификатор сети, к которой принадлежит этот порт. |
| security_groups список | успех | Группа(ы) безопасности, связанная(ые) с этим портом. |
| status строка | успех | Состояние порта. |
| tenant_id строка | успех | Идентификатор арендатора, связанный с этим портом. |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробную информацию см. в разделе Техническое обслуживание модулей и поддержка.
Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.
Автор
- 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.6/modules/os_port_module.html
