Модуль openstack.cloud.address_scope — создание или удаление областей адресов в OpenStack
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.address_scope.
Краткое описание
- Создание или удаление областей адресов в OpenStack.
Требования
Перечисленные ниже компоненты должны быть установлены на узле, на котором выполняется этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Описание |
|---|---|
api_timeout integer | Время ожидания на уровне сокета перед истечением времени ожидания вызовов API. Если параметр не указан, библиотеке requests ничего не передаётся. |
auth dictionary | Словарь с данными аутентификации, необходимыми для стратегии модуля аутентификации облака. Для стандартного модуля password в нём должны быть указаны auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других модулей аутентификации этот параметр должен содержать все необходимые им параметры. Этот параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*. |
auth_type string | Имя используемого модуля аутентификации. Если облако использует не аутентификацию по паролю, здесь следует указать имя модуля и соответствующим образом изменить содержимое параметра auth. |
ca_cert псевдонимы: cacert string | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API по SSL. |
client_cert псевдонимы: cert string | Путь к сертификату клиента, используемому при обмене данными по SSL. |
client_key псевдонимы: key string | Путь к ключу клиента, используемому при обмене данными по SSL. |
cloud any | Именованное облако или конфигурация облака, с которой нужно работать. Если значение cloud — строка, она указывает на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Задаёт значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или заданы переменные среды OpenStack OS_*. Если значение cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу clouds.yaml. |
extra_specs dictionary | Словарь с дополнительными парами ключ/значение, передаваемыми в API По умолчанию: |
interface псевдонимы: endpoint_type string | Тип URL конечной точки, получаемой из каталога служб. Варианты:
|
ip_version string | Версия IP подсети: 4 или 6. Этот параметр нельзя изменить. Варианты:
|
псевдонимы: shared boolean | Является ли эта область адресов общей. Варианты:
|
name string / обязательный | Имя области адресов Этот параметр нельзя изменить. |
project string | Уникальное имя или идентификатор проекта. Этот параметр нельзя изменить. |
region_name string | Имя региона. |
sdk_log_level string | Уровень журналирования OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается |
state string | Требуемое состояние ресурса Варианты:
|
timeout integer | Время, в течение которого Ansible ожидает запрошенный ресурс. По умолчанию: |
validate_certs псевдонимы: verify boolean | Следует ли проверять запросы API по SSL. До Ansible 2.3 значением по умолчанию было Варианты:
|
wait boolean | Должен ли Ansible ожидать завершения операции с запрошенным ресурсом. Варианты:
|
Примечания
Примечание
- Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например
OS_USERNAME. - Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явно заданных параметров в плейбуках. Дополнительная информация доступна по адресу https://docs.openstack.org/openstacksdk/
Примеры
# Create an IPv4 address scope.
- openstack.cloud.address_scope:
cloud: mycloud
state: present
name: my_adress_scope
# Create a shared IPv6 address scope for a given project.
- openstack.cloud.address_scope:
cloud: mycloud
state: present
ip_version: 6
name: ipv6_address_scope
project: myproj
# Delete address scope.
- openstack.cloud.address_scope:
cloud: mycloud
state: absent
name: my_adress_scope
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
address_scope dictionary | Словарь с описанием области адресов. Возвращается: при успешном выполнении, если state имеет значение ‘present’ |
|
id string |
Идентификатор области адресов. Возвращается: при успешном выполнении Пример: |
|
ip_version string |
Версия IP подсети: 4 или 6. Возвращается: при успешном выполнении Пример: |
|
boolean |
Указывает, доступна ли эта область адресов всем арендаторам. Возвращается: при успешном выполнении Пример: |
|
name string |
Имя области адресов. Возвращается: при успешном выполнении Пример: |
|
project_id string |
Идентификатор проекта Возвращается: при успешном выполнении Пример: |
|
tenant_id string |
Идентификатор арендатора. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/address_scope_module.html