Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: ngine_io.cloudstack.cs_portforward.

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

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

Обзор

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

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • python >= 2.6
  • cs >= 0.9.0

Параметры

Параметр

Комментарии

account

string

Учетная запись, с которой связана vm.

api_http_method

string

HTTP-метод, используемый для запроса к конечной точке API.

Если не указано, используется переменная окружения CLOUDSTACK_METHOD.

Варианты:

  • "get" ← (default)
  • "post"

api_key

string / required

Ключ API CloudStack API.

Если не указано, используется переменная окружения CLOUDSTACK_KEY.

api_secret

string / required

Секретный ключ CloudStack API.

Если не указано, используется переменная окружения CLOUDSTACK_SECRET.

api_timeout

integer

Таймаут HTTP в секундах.

Если не указано, используется переменная окружения CLOUDSTACK_TIMEOUT.

По умолчанию: 10

api_url

string / required

URL CloudStack API, например https://cloud.example.com/client/api.

Если не указано, используется переменная окружения CLOUDSTACK_ENDPOINT.

api_verify_ssl_cert

string

Проверка файла сертификата центра сертификации.

Если не указано, используется переменная окружения CLOUDSTACK_VERIFY.

domain

string

Домен, с которым связана vm.

ip_address

string / required

Публичный IP-адрес, которому назначено правило.

network

string

Имя сети. Требуется при переадресации портов в VPC.

open_firewall

boolean

Следует ли создавать правило брандмауэра для публичного порта при создании нового правила.

Не поддерживается при переадресации портов в VPC.

Используйте ngine_io.cloudstack.cs_firewall для управления правилами брандмауэра.

Варианты:

  • false ← (default)
  • true

poll_async

boolean

Опрашивать асинхронные задания до их завершения.

Варианты:

  • false
  • true ← (default)

private_end_port

integer

Конечный частный порт для этого правила.

Если не указано, равно private_port.

private_port

integer / required

Начальный частный порт для этого правила.

project

string

Имя проекта, в котором находится vm.

protocol

string

Протокол правила переадресации портов.

Варианты:

  • "tcp" ← (default)
  • "udp"

public_end_port

integer

Конечный публичный порт для этого правила.

Если не указано, равно public_port.

public_port

integer / required

Начальный публичный порт для этого правила.

state

string

Состояние правила переадресации портов.

Варианты:

  • "present" ← (default)
  • "absent"

tags

aliases: tag

list / elements=dictionary

Список тегов. Теги представляют собой список словарей с ключами key и value.

Чтобы удалить все теги, установите пустой список, например tags: [].

validate_certs

boolean

added in ngine_io.cloudstack 2.4.0

Если false, сертификаты SSL не будут проверены.

Если не задано, используется значение переменной среды CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY.

Использовать следует только на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов.

Варианты:

  • false
  • true ← (по умолчанию)

vm

string

Имя виртуальной машины, для которой создаётся правило перенаправления портов.

Требуется, если state=present.

vm_guest_ip

string

Вторичный IP-адрес гостевой сетевой карты виртуальной машины для правила перенаправления портов.

vpc

string

Имя VPC.

zone

string / обязательно

Имя зоны, в которой находится виртуальная машина.

Примечания

Примечание

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

Примеры

- name: 1.2.3.4:80 -> web01:8080
  ngine_io.cloudstack.cs_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.cs_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.cs_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.cs_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.cs_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-адреса.

Возвращается: успешно

Пример: "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"

Авторы

  • René Moser (@resmo)

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

  • Система отслеживания задач
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_portforward_module.html

Spec-Zone.ru

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