Spec-Zone.ru › Ansible 2.4

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
нет None
Сколько времени должен ждать уровень сокета перед истечением времени ожидания для вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов.
auth
нет
Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для стандартного плагина password он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые этому плагину. Этот параметр не нужен, если указано имя облака или присутствуют переменные среды OpenStack OS_*.
auth_type
нет password
Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть обновлено соответствующим образом.
availability_zone
нет
Игнорируется. Присутствует для обратной совместимости
cacert
нет None
Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL.
cert
нет None
Путь к клиенту сертификат для использования в рамках транзакции SSL.
cloud
нет
Имя облака для работы. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные среды OpenStack OS_*.
device_id
нет None
Идентификатор устройства, использующего этот порт.
device_owner
нет None
Идентификатор сущности, использующей этот порт.
endpoint_type
нет public
  • public
  • internal
  • admin
Тип URL конечной точки для извлечения из каталога служб.
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.
key
нет None
Путь к ключу клиента для использования в рамках транзакции SSL.
mac_address
нет None
MAC-адрес этого порта.
name
нет None
Имя, которое должно быть присвоено порту.
network
да
Идентификатор или имя сети, к которой принадлежит этот порт.
no_security_groups
нет
Не ассоциировать группу безопасности с этим портом.
region_name
нет
Имя региона.
security_groups
нет None
Идентификатор(ы) или имя(а) группы(и) безопасности, связанной(ые) с портом (строка с запятыми или YAML-список)
state
нет present
  • present
  • absent
Должен ли ресурс быть присутствующим или отсутствующим.
timeout
нет 180
Сколько времени Ansible должен ждать запрошенного ресурса.
validate_certs
нет
Требуется ли проверка запросов API SSL. До версии 2.3 по умолчанию было True.
псевдонимы: verify
wait
нет yes
  • yes
  • no
Должен ли Ansible ждать завершения запрошенного ресурса.

Примеры

# Create a port
- os_port:
    state: present
    auth:
      auth_url: https://region-b.geo-1.identity.hpcloudsvc.com:35357/v2.0/
      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://region-b.geo-1.identity.hpcloudsvc.com:35357/v2.0/
      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://region-b.geo-1.identity.hpcloudsvc.com:35357/v2.0/
      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://region-b.geo-1.identity.hpcloudsvc.com:35357/v2.0/d
      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://region-b.geo-1.identity.hpcloudsvc.com:35357/v2.0/d
      username: admin
      password: admin
      project_name: admin
    name: port1
    security_groups:
      - 1496e8c7-4918-482a-9172-f4f00fc4a3a5
      - 057d4bdf-6d4d-472...

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

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

имя описание возвращается тип пример
admin_state_up
Флаг admin state up для этого порта.
успех bool
allowed_address_pairs
Разрешенные пары адресов с этим портом.
успех список
fixed_ips
Фиксированный(ые) IP-адрес(ы), связанные с этим портом.
успех список
id
Уникальный UUID.
успех строка
name
Имя, присвоенное порту.
успех строка
network_id
Идентификатор сети, в которой находится этот порт.
успех строка
security_groups
Группа(ы) безопасности, связанная(ые) с этим портом.
успех список
status
Статус порта.
успех строка
tenant_id
Идентификатор арендатора, связанный с этим портом.
успех строка

Примечания

Примечание

  • Могут использоваться стандартные переменные среды 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

Статус

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

Для получения помощи в разработке модулей, если вы так пожелаете, пожалуйста, ознакомьтесь с Информация о сообществе и сотрудничестве, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API