Spec-Zone.ru › Ansible 2.8

cs_portforward – Управляет правилами переадресации портов в облаках на базе Apache CloudStack

Новая версия 2.0.

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

Описание

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

Требования

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

  • python >= 2.6
  • cs >= 0.6.10

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
account
строка
Аккаунт, к которому относится vm.
api_http_method
строка
    Варианты:
  • get
  • post
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
строка
добавлен в 2.3
Имя сети.
open_firewall
логическое
    Варианты:
  • нет ←
  • да
Создавать ли правило брандмауэра для общедоступного порта при создании нового правила.
Используйте cs_firewall для управления правилами брандмауэра.
poll_async
логическое
    Варианты:
  • нет
  • да ←
Ожидать завершения асинхронных задач.
private_end_port
целое число
Конечный частный порт для этого правила.
Если не указано, равно private_port.
private_port
целое число / обязательно
Начальный частный порт для этого правила.
project
строка
Имя проекта, в котором находится vm.
protocol
строка
    Варианты:
  • tcp ←
  • udp
Протокол правила переадресации портов.
public_end_port
целое число
Конечный общедоступный порт для этого правила.
Если не указано, равно public_port.
public_port
целое число / обязательно
Начальный общедоступный порт для этого правила.
state
строка
    Варианты:
  • present ←
  • absent
Состояние правила переадресации портов.
tags
список
добавлен в 2.4
Список тегов. Теги представляют собой список словарей, содержащих ключи key и value.
Для удаления всех тегов установите пустой список, например, tags: [].

псевдонимы: tag
vm
строка
Имя виртуальной машины, для которой создается правило переадресации портов.
Обязательно, если state=present.
vm_guest_ip
строка
Вторичный IP-адрес гостевой сети ВМ для правила переадресации портов.
vpc
строка
добавлен в 2.3
Имя 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.8/modules/cs_portforward_module.html

Spec-Zone.ru

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