cs_portforward – Управляет правилами переадресации портов в облаках на основе Apache CloudStack
Описание
- Создание, обновление и удаление правил переадресации портов.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account строка | Аккаунт, к которому относится vm. | |
| api_http_method строка |
| HTTP-метод, используемый для запроса к API-точке. Если не указано, используется значение переменной среды CLOUDSTACK_METHOD. В качестве последнего варианта, значение берётся из файла конфигурации ini, см. также примечания. Значение по умолчанию get, если не указано. |
| api_key строка | API-ключ API CloudStack. Если не указано, используется значение переменной среды CLOUDSTACK_KEY. В качестве последнего варианта, значение берётся из файла конфигурации ini, см. также примечания. | |
| api_region строка | По умолчанию: "cloudstack" | Имя раздела ini в файле cloustack.ini. Если не указано, используется значение переменной среды CLOUDSTACK_REGION. |
| api_secret строка | Секретный ключ API CloudStack. Если не задано, используется значение переменной среды CLOUDSTACK_SECRET. В качестве последнего варианта, значение берётся из файла конфигурации ini, см. также примечания. | |
| api_timeout целое число | Таймаут HTTP в секундах. Если не указано, используется значение переменной среды CLOUDSTACK_TIMEOUT. В качестве последнего варианта, значение берётся из файла конфигурации ini, см. также примечания. Значение по умолчанию 10 секунд, если не указано. | |
| api_url строка | URL API CloudStack, например, https://cloud.example.com/client/api. Если не указано, используется значение переменной среды CLOUDSTACK_ENDPOINT. В качестве последнего варианта, значение берётся из файла конфигурации ini, см. также примечания. | |
| domain строка | Домен, к которому относится vm. | |
| ip_address строка / обязательно | Общедоступный IP-адрес, которому назначено правило. | |
| network строка | Имя сети. | |
| open_firewall логическое значение |
| Создавать ли правило брандмауэра для публичного порта при создании нового правила. Для управления правилами брандмауэра используйте cs_firewall. |
| poll_async логическое значение |
| Ожидать завершения асинхронных задач. |
| private_end_port целое число | Конечный номер частного порта для этого правила. Если не указан, равен private_port. | |
| private_port целое число / обязательно | Начальный номер частного порта для этого правила. | |
| project строка | Имя проекта, в котором расположена vm. | |
| protocol строка |
| Протокол правила переадресации портов. |
| public_end_port целое число | Конечный номер публичного порта для этого правила. Если не указан, равен public_port. | |
| public_port целое число / обязательно | Начальный номер публичного порта для этого правила. | |
| state строка |
| Состояние правила переадресации портов. |
| tags список добавлено в 2.4 | Список тегов. Теги — список словарей с ключами key и value. Чтобы удалить все теги, установите пустой список, например, tags: []. псевдонимы: тег | |
| vm строка | Имя виртуальной машины, для которой создаётся правило переадресации портов. Требуется, если state=present. | |
| vm_guest_ip строка | Вторичный IP-адрес гостевой сети виртуальной машины для правила переадресации портов. | |
| 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: 1.2.3.4:80 -> web01:8080
cs_portforward:
ip_address: 1.2.3.4
vm: web01
public_port: 80
private_port: 8080
delegate_to: localhost
- name: forward SSH and open firewall
cs_portforward:
ip_address: '{{ public_ip }}'
vm: '{{ inventory_hostname }}'
public_port: '{{ ansible_ssh_port }}'
private_port: 22
open_firewall: true
delegate_to: localhost
- name: forward DNS traffic, but do not open firewall
cs_portforward:
ip_address: 1.2.3.4
vm: '{{ inventory_hostname }}'
public_port: 53
private_port: 53
protocol: udp
delegate_to: localhost
- name: remove ssh port forwarding
cs_portforward:
ip_address: 1.2.3.4
public_port: 22
private_port: 22
state: absent
delegate_to: localhost
Возвращаемые значения
Общие значения, возвращаемые модулем, описаны в документации, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | успех | UUID публичного IP-адреса. Пример: a6f7a5fc-43f8-11e5-a151-feff819cdc9f |
| ip_address строка | успех | Публичный IP-адрес. Пример: 1.2.3.4 |
| network строка | успех | Имя сети. Пример: dmz |
| private_end_port целое число | успех | Конечный порт по IP-адресу виртуальной машины. Пример: 80 |
| private_port целое число | успех | Начальный порт по IP-адресу виртуальной машины. Пример: 80 |
| protocol строка | успех | Протокол. Пример: tcp |
| public_end_port целое число | успех | Конечный порт по публичному IP-адресу. Пример: 80 |
| public_port целое число | успех | Начальный порт по публичному IP-адресу. Пример: 80 |
| tags список | успех | Теги, относящиеся к переадресации портов. |
| vm_display_name строка | успех | Имя отображения виртуальной машины. Пример: web-01 |
| vm_guest_ip строка | успех | IP виртуальной машины. Пример: 10.101.65.152 |
| vm_name строка | успех | Имя виртуальной машины. Пример: web-01 |
| vpc строка | успех | Имя VPC. Пример: my_vpc |
Статус
- В этом модуле гарантируются изменения интерфейса, совместимые с предыдущими версиями. [stableinterface]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/cs_portforward_module.html