cs_staticnat – Управляет статическими NAT на облаках на базе Apache CloudStack

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

Краткое описание

Создание, обновление и удаление статических NAT.

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account строка		Аккаунт, к которому относится статический NAT.
api_http_method строка	Варианты: get post	Метод 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, см. также примечания.
domain строка		Домен, к которому относится статический NAT.
ip_address строка / обязательно		Публичный IP-адрес, назначенный статическому NAT.
network строка		Сеть, к которой относится IP-адрес.
poll_async логическое значение	Варианты: нет да ←	Опрашивать асинхронные задания до их завершения.
project строка		Имя проекта, к которому относится статический NAT.
state строка	Варианты: present ← absent	Состояние статического 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 Переменная среды, указывающая на файл .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
  cs_staticnat:
    ip_address: 1.2.3.4
    vm: web01
  delegate_to: localhost

- name: Remove a static NAT
  cs_staticnat:
    ip_address: 1.2.3.4
    state: absent
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
account строка	успех	Аккаунт, к которому относится статический NAT. Пример: example account
domain строка	успех	Домен, к которому относится статический NAT. Пример: example domain
id строка	успех	UUID ip_address. Пример: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
ip_address строка	успех	Публичный IP-адрес. Пример: 1.2.3.4
project строка	успех	Имя проекта, к которому относится статический NAT. Пример: Production
vm_display_name строка	успех	Имя отображения виртуальной машины. Пример: web-01
vm_guest_ip строка	успех	IP виртуальной машины. Пример: 10.101.65.152
vm_name строка	успех	Имя виртуальной машины. Пример: web-01
zone строка	успех	Имя зоны, к которой относится статический NAT. Пример: ch-gva-2

Статус

Этот модуль гарантированно будет иметь обратную совместимость в будущих изменениях интерфейса. [stableinterface]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Рене Мозер (@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_staticnat_module.html