Spec-Zone.ru › Ansible 2.7

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

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

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

Обзор

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

Требования

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

  • python >= 2.6
  • cs >= 0.6.10

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
account
-
Аккаунт, к которому относится статический NAT.
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
-
Домен, к которому относится статический NAT.
ip_address
- / обязательно
Общедоступный IP-адрес, назначенный статическому NAT.
network
-
добавлен в 2.2
Сеть, к которой относится IP-адрес.
poll_async
boolean
    Варианты:
  • no
  • да ←
Проверять асинхронные задачи, пока задача не завершена.
project
-
Название проекта, к которому относится статический NAT.
state
-
    Варианты:
  • present ←
  • absent
Состояние статического NAT.
vm
-
Имя виртуальной машины, для которой создаётся статический NAT.
Требуется, если state=present.
vm_guest_ip
boolean
    Варианты:
  • нет ←
  • да
Вторичный IP-адрес гостевой виртуальной машины для статического NAT.
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.
  • Этот модуль поддерживает режим проверки.

Примеры

# create a static NAT: 1.2.3.4 -> web01
- local_action:
    module: cs_staticnat
    ip_address: 1.2.3.4
    vm: web01

# remove a static NAT
- local_action:
    module: cs_staticnat
    ip_address: 1.2.3.4
    state: absent

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

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

Ключ Возвращаемое значение Описание
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]

Авторы

  • 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.7/modules/cs_staticnat_module.html

Spec-Zone.ru

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