Spec-Zone.ru › Ansible 2.4

os_networks_facts - Получение фактов о одной или нескольких сетях OpenStack.

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

  • Описание
  • Требования (к хосту, выполняющему модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус

Описание

  • Получение фактов о одной или нескольких сетях из OpenStack.

Требования (к хосту, выполняющему модуль)

  • python >= 2.6
  • python >= 2.7
  • shade

Параметры

параметр обязательно значение по умолчанию допустимые значения комментарии
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_*.
endpoint_type
нет public
  • public
  • internal
  • admin
Тип URL-адреса конечной точки для извлечения из каталога сервисов.
filters
нет
Словарь метаданных для дальнейшей фильтрации. Элементы этого словаря могут быть дополнительными словарями.
key
нет None
Путь к клиенту ключу для использования в рамках транзакции SSL.
name
нет
Имя или ID сети
region_name
нет
Название региона.
timeout
нет 180
Сколько времени Ansible должен ждать запрашиваемого ресурса.
validate_certs
нет
Необходимо ли проверять запросы API SSL. До версии 2.3 по умолчанию было True.
псевдонимы: verify
wait
нет yes
  • yes
  • no
Должен ли Ansible ждать, пока запрашиваемый ресурс не будет завершен.

Примеры

- name: Gather facts about previously created networks
  os_networks_facts:
    auth:
      auth_url: https://your_api_url.com:9000/v2.0
      username: user
      password: password
      project_name: someproject

- name: Show openstack networks
  debug:
    var: openstack_networks

- name: Gather facts about a previously created network by name
  os_networks_facts:
    auth:
      auth_url: https://your_api_url.com:9000/v2.0
      username: user
      password: password
      project_name: someproject
    name:  network1

- name: Show openstack networks
  debug:
    var: openstack_networks

- name: Gather facts about a previously created network with filter
  # Note: name and filters parameters are Not mutually exclusive
  os_networks_facts:
    auth:
      auth_url: https://your_api_url.com:9000/v2.0
      username: user
      password: password
      project_name: someproject
    filters:
      tenant_id: 55e2ce24b2a245b09f181bf025724cbe
      subnets:
        - 057d4bdf-6d4d-4728-bb0f-5ac45a6f7400
        - 443d4dc0-91d4-4998-b21c-357d10433483

- name: Show openstack networks
  debug:
    var: openstack_networks

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

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

имя описание возвращается тип пример
openstack_networks
содержит все факты OpenStack о сетях
всегда, но может быть null сложный
содержит:
имя описание возвращается тип пример
status
Статус сети.
успех строка
subnets
Подсети, включенные в эту сеть.
успех список строк
name
Имя, заданное сети.
успех строка
shared
Флаг совместного использования сети.
успех булево
tenant_id
Идентификатор клиента, связанный с этой сетью.
успех строка
id
Уникальный UUID.
успех строка

Примечания

Примечание

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

Spec-Zone.ru

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