Модуль ngine_io.cloudstack.portforward — управление правилами перенаправления портов в облаках на базе Apache CloudStack.

Примечание

Этот модуль входит в состав коллекции ngine_io.cloudstack (версия 3.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install ngine_io.cloudstack. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: ngine_io.cloudstack.portforward.

Добавлено в ngine_io.cloudstack 0.1.0

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Создание, обновление и удаление правил перенаправления портов.

Псевдонимы: cs_portforward

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Описание
account строка	Учетная запись, с которой связана виртуальная машина vm.
api_http_method строка	Метод HTTP, используемый для запроса к конечной точке API. Если параметр не задан, используется переменная окружения `CLOUDSTACK_METHOD`. Варианты: `"get"` ← (по умолчанию) `"post"`
api_key строка / обязательный	Ключ API CloudStack. Если параметр не задан, используется переменная окружения `CLOUDSTACK_KEY`.
api_secret строка / обязательный	Секретный ключ API CloudStack. Если параметр не задан, используется переменная окружения `CLOUDSTACK_SECRET`.
api_timeout целое число	Тайм-аут HTTP в секундах. Если параметр не задан, используется переменная окружения `CLOUDSTACK_TIMEOUT`. По умолчанию: `10`
api_url строка / обязательный	URL API CloudStack, например https://cloud.example.com/client/api. Если параметр не задан, используется переменная окружения `CLOUDSTACK_ENDPOINT`.
api_verify_ssl_cert строка	Проверять файл сертификата центра сертификации. Если параметр не задан, используется переменная окружения `CLOUDSTACK_VERIFY`.
domain строка	Домен, с которым связана виртуальная машина vm.
ip_address строка / обязательный	Общедоступный IP-адрес, для которого назначается правило.
network строка	Имя сети. Обязательный параметр при перенаправлении портов в VPC.
open_firewall логический	Создавать ли правило брандмауэра для общедоступного порта при создании нового правила. Не поддерживается при перенаправлении портов в VPC. Для управления правилами брандмауэра используйте ngine_io.cloudstack.cs_firewall. Варианты: `false` ← (по умолчанию) `true`
poll_async логический	Ожидать завершения асинхронных заданий, проверяя их состояние. Варианты: `false` `true` ← (по умолчанию)
private_end_port целое число	Конечный внутренний порт для этого правила. Если не указан, равен private_port.
private_port целое число / обязательный	Начальный внутренний порт для этого правила.
project строка	Имя проекта, в котором находится виртуальная машина vm.
protocol строка	Протокол правила перенаправления портов. Варианты: `"tcp"` ← (по умолчанию) `"udp"`
public_end_port целое число	Конечный общедоступный порт для этого правила. Если не указан, равен public_port.
public_port целое число / обязательный	Начальный общедоступный порт для этого правила.
state строка	Состояние правила перенаправления портов. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags псевдонимы: tag список / элементы=словарь	Список тегов. Теги представляют собой список словарей с ключами key и value. Чтобы удалить все теги, задайте пустой список, например tags: [].
validate_certs логический добавлено в ngine_io.cloudstack 2.4.0	Если `false`, SSL-сертификаты не будут проверяться. Если параметр не задан, используется переменная окружения `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY`. Этот параметр следует использовать только на контролируемых вами сайтах, где применяются самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)
vm строка	Имя виртуальной машины, для которой создается правило перенаправления портов. Обязательный параметр, если state=present.
vm_guest_ip строка	Дополнительный IP-адрес сетевого интерфейса гостевой ОС виртуальной машины для правила перенаправления портов.
vpc строка	Имя VPC.
zone строка / обязательный	Имя зоны, в которой находится виртуальная машина.

Примечания

Примечание

Подробное руководство по модулям CloudStack можно найти в руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: 1.2.3.4:80 -> web01:8080
  ngine_io.cloudstack.portforward:
    ip_address: 1.2.3.4
    zone: zone01
    vm: web01
    public_port: 80
    private_port: 8080

- name: forward SSH and open firewall
  ngine_io.cloudstack.portforward:
    ip_address: '{{ public_ip }}'
    zone: zone01
    vm: '{{ inventory_hostname }}'
    public_port: '{{ ansible_ssh_port }}'
    private_port: 22
    open_firewall: true

- name: forward DNS traffic, but do not open firewall
  ngine_io.cloudstack.portforward:
    ip_address: 1.2.3.4
    zone: zone01
    vm: '{{ inventory_hostname }}'
    public_port: 53
    private_port: 53
    protocol: udp

- name: remove ssh port forwarding
  ngine_io.cloudstack.portforward:
    ip_address: 1.2.3.4
    zone: zone01
    public_port: 22
    private_port: 22
    state: absent

- name: forward SSH in backend tier of VPC
  ngine_io.cloudstack.portforward:
    ip_address: '{{ public_ip }}'
    zone: zone01
    vm: '{{ inventory_hostname }}'
    public_port: '{{ ansible_ssh_port }}'
    private_port: 22
    vpc: myVPC
    network: backend

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

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

Ключ	Описание
id строка	UUID общедоступного IP-адреса. Возвращается: success Пример: `"a6f7a5fc-43f8-11e5-a151-feff819cdc9f"`
ip_address строка	Общедоступный IP-адрес. Возвращается: success Пример: `"1.2.3.4"`
network строка	Имя сети. Возвращается: success Пример: `"dmz"`
private_end_port целое число	Конечный порт на IP-адресе виртуальной машины. Возвращается: success Пример: `80`
private_port целое число	Начальный порт на IP-адресе виртуальной машины. Возвращается: success Пример: `80`
protocol строка	Протокол. Возвращается: success Пример: `"tcp"`
public_end_port целое число	Конечный порт на общедоступном IP-адресе. Возвращается: success Пример: `80`
public_port целое число	Начальный порт на общедоступном IP-адресе. Возвращается: success Пример: `80`
tags список / элементы=строка	Теги, связанные с перенаправлением портов. Возвращается: success Пример: `[]`
vm_display_name строка	Отображаемое имя виртуальной машины. Возвращается: success Пример: `"web-01"`
vm_guest_ip строка	IP-адрес виртуальной машины. Возвращается: success Пример: `"10.101.65.152"`
vm_name строка	Имя виртуальной машины. Возвращается: success Пример: `"web-01"`
vpc строка	Имя VPC. Возвращается: success Пример: `"my_vpc"`

Авторы

René Moser (@resmo)

Ссылки на коллекцию

© 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/ngine_io/cloudstack/portforward_module.html