ngine_io.cloudstack.cs_staticnat – Управляет статическими NAT на облаках на основе Apache CloudStack.
Примечание
Этот плагин является частью коллекции ngine_io.cloudstack (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.cloudstack.
Для использования в плейбуке укажите: ngine_io.cloudstack.cs_staticnat.
Добавлено в версии 0.1.0: of ngine_io.cloudstack
Обзор
- Создание, обновление и удаление статических NAT.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- cs >= 0.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account строка | Аккаунт, к которому относится статический NAT. | |
| api_http_method строка |
| HTTP-метод, используемый для запроса API-точки входа. Если не задано, используется переменная среды CLOUDSTACK_METHOD. В качестве последнего варианта, значение берётся из файла конфигурации ini, см. также примечания. Значение по умолчанию get, если не указано. |
| api_key строка | API-ключ CloudStack API. Если не задано, используется переменная среды CLOUDSTACK_KEY. В качестве последнего варианта, значение берётся из файла конфигурации ini, см. также примечания. | |
| api_region строка | Значение по умолчанию: "cloudstack" | Имя раздела ini в файле cloustack.ini. Если не задано, используется переменная среды CLOUDSTACK_REGION. |
| api_secret строка | Секретный ключ CloudStack API. Если не задано, используется переменная среды CLOUDSTACK_SECRET. В качестве последнего варианта, значение берётся из файла конфигурации ini, см. также примечания. | |
| api_timeout целое число | Таймаут HTTP в секундах. Если не задано, используется переменная среды CLOUDSTACK_TIMEOUT. В качестве последнего варианта, значение берётся из файла конфигурации ini, см. также примечания. Значение по умолчанию 10 секунд, если не указано. | |
| api_url строка | URL CloudStack API, например, https://cloud.example.com/client/api. Если не задано, используется переменная среды CLOUDSTACK_ENDPOINT. В качестве последнего варианта, значение берётся из файла конфигурации ini, см. также примечания. | |
| api_verify_ssl_cert строка | Файл сертификата CA. Если не задано, используется переменная среды CLOUDSTACK_VERIFY. В качестве последнего варианта, значение берётся из файла конфигурации ini, см. также примечания. Значение по умолчанию null, если не указано. | |
| domain строка | Домен, к которому относится статический NAT. | |
| ip_address строка / обязательно | Общедоступный IP-адрес, назначенный статическому NAT. | |
| network строка | Сеть, к которой относится IP-адрес. | |
| poll_async логический тип |
| Отслеживать асинхронные задачи до завершения. |
| project строка | Имя проекта, к которому относится статический NAT. | |
| state строка |
| Состояние статического NAT. |
| vm строка | Имя виртуальной машины, для которой создаётся статический NAT. Требуется, если state=present. | |
| vm_guest_ip строка | Вторичный IP-адрес гостевой сети виртуальной машины для статического NAT. | |
| vpc строка | VPC, к которой относится сеть. | |
| zone строка | Имя зоны, в которой находится виртуальная машина. Если не задано, используется зона по умолчанию. |
Примечания
Примечание
- Ansible использует метод конфигурации библиотеки
cs, если учетные данные не предоставлены аргументамиapi_url,api_key,api_secret. Конфигурация считывается из нескольких мест в следующем порядке.CLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETиCLOUDSTACK_METHOD. Переменные средыCLOUDSTACK_TIMEOUT. Переменная средыCLOUDSTACK_CONFIG, указывающая на файл.ini. Файлcloudstack.iniв текущей рабочей директории. Файл.cloudstack.iniв домашней директории пользователя. Допускается указание нескольких учетных данных и конечных точек с использованием разделов ini вcloudstack.ini. Используйте аргументapi_regionдля выбора имени раздела, раздел по умолчаниюcloudstack. Дополнительную информацию см. на https://github.com/exoscale/cs. - Подробное руководство по модулям cloudstack можно найти в Руководстве по облаку CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Create a static NAT for IP 1.2.3.4 to web01
ngine_io.cloudstack.cs_staticnat:
ip_address: 1.2.3.4
vm: web01
- name: Remove a static NAT
ngine_io.cloudstack.cs_staticnat:
ip_address: 1.2.3.4
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| account строка | успешно | Аккаунт, к которому относится статический NAT. Пример: аккаунт пример |
| domain строка | успешно | Домен, к которому относится статический NAT. Пример: домен пример |
| id строка | успешно | UUID ip_address. Пример: a6f7a5fc-43f8-11e5-a151-feff819cdc9f |
| ip_address строка | успешно | Общедоступный IP-адрес. Пример: 1.2.3.4 |
| project строка | успешно | Имя проекта, к которому относится статический NAT. Пример: Производство |
| vm_display_name строка | успешно | Имя отображения виртуальной машины. Пример: web-01 |
| vm_guest_ip строка | успешно | IP виртуальной машины. Пример: 10.101.65.152 |
| vm_name строка | успешно | Имя виртуальной машины. Пример: web-01 |
| zone строка | успешно | Имя зоны, к которой относится статический NAT. Пример: ch-gva-2 |
Авторы
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ngine_io/cloudstack/cs_staticnat_module.html