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

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

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

Описание

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

Требования

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

python >= 2.7
shade

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
admin_state_up	По умолчанию: None	Устанавливает состояние администратора.
allowed_address_pairs	По умолчанию: None	Список разрешенных пар адресов. Разрешенные пары адресов поддерживаются со структурой словаря. Например: 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	По умолчанию: None	Идентификатор устройства, использующего этот порт.
device_owner	По умолчанию: None	Идентификатор сущности, использующей этот порт.
extra_dhcp_opts	По умолчанию: None	Дополнительные параметры DHCP, которые необходимо назначить этому порту. Дополнительные параметры поддерживаются со структурой словаря. Например: extra_dhcp_opts: - opt_name: opt name1 opt_value: value1 - opt_name: ...
fixed_ips	По умолчанию: None	Желаемый IP-адрес и/или подсеть для этого порта. Подсеть указана по идентификатору subnet_id, а IP - по ip_address.
interface (добавлено в 2.3)	Варианты: public ← internal admin	Тип URL конечной точки для извлечения из каталога сервисов. псевдонимы: endpoint_type
key		Путь к клиентскому ключу для использования в транзакции SSL.
mac_address	По умолчанию: None	MAC-адрес этого порта.
name	По умолчанию: None	Имя, которое должно быть присвоено порту.
network обязательно		Идентификатор или имя сети, к которой принадлежит этот порт.
no_security_groups	По умолчанию: no	Не ассоциировать группу безопасности с этим портом.
region_name		Имя региона.
security_groups	По умолчанию: None	Идентификатор(ы) или имя(на) группы безопасности, связанной(ые) с портом (строка через запятую или список YAML)
state	Варианты: present ← absent	Должен ли ресурс быть present или absent.
timeout	По умолчанию: 180	Сколько времени Ansible должно ждать запрашиваемого ресурса.
verify	Варианты: no yes	Нужно ли проверять запросы SSL API. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs
wait	Варианты: no yes ←	Должен ли 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	success	Флаг состояния администратора для этого порта.
allowed_address_pairs list	success	Разрешенные пары адресов с этим портом.
fixed_ips list	success	Фиксированный(ые) IP-адрес(ы), связанный(ые) с этим портом.
id string	success	Уникальный UUID.
name string	success	Имя, заданное порту.
network_id string	success	Идентификатор сети, в которой находится этот порт.
security_groups list	success	Группа(ы) безопасности, связанная(ые) с этим портом.
status string	success	Статус порта.
tenant_id string	success	Идентификатор клиента, связанный с этим портом.

Статус

Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.

Автор

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.5/modules/os_port_module.html