Spec-Zone.ru › Ansible 2.7

cs_instance_nic_secondaryip – Управляет дополнительными IP-адресами экземпляра на облаках на основе Apache CloudStack.

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

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

Обзор

  • Добавляет и удаляет дополнительные IP-адреса к сетевой карте экземпляра.

Требования

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

  • python >= 2.6
  • cs >= 0.6.10

Параметры

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

алиасы: имя
vm_guest_ip
-
Дополнительный IP-адрес, который нужно добавить к сетевой карте экземпляра.
Если не указан, API всегда возвращает новый IP-адрес, и идемпотентность не гарантируется.

алиасы: secondary_ip
vpc
-
Имя VPC, к которому относится vm.
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: Assign a specific IP to the default NIC of the VM
  local_action:
    module: cs_instance_nic_secondaryip
    vm: customer_xy
    vm_guest_ip: 10.10.10.10

# Note: If vm_guest_ip is not set, you will get a new IP address on every run.
- name: Assign an IP to the default NIC of the VM
  local_action:
    module: cs_instance_nic_secondaryip
    vm: customer_xy

- name: Remove a specific IP from the default NIC
  local_action:
    module: cs_instance_nic_secondaryip
    vm: customer_xy
    vm_guest_ip: 10.10.10.10
    state: absent

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

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

Ключ Возвращаемое Описание
account
строка
успех
Аккаунт, связанный с виртуальной машиной.

Пример:
примерный аккаунт
domain
строка
успех
Домен, связанный с виртуальной машиной.

Пример:
примерный домен
id
строка
успех
UUID сетевой карты.

Пример:
87b1e0ce-4e01-11e4-bb66-0050569e64b8
ip_address
строка
успех
Основной IP-адрес сетевой карты.

Пример:
10.10.10.10
mac_address
строка
успех
MAC-адрес сетевой карты.

Пример:
02:00:33:31:00:e4
netmask
строка
успех
Маска подсети сетевой карты.

Пример:
255.255.255.0
network
строка
успех
Имя сети, если это не сеть по умолчанию.

Пример:
синхронная сеть
project
строка
успех
Имя проекта, к которому относится виртуальная машина.

Пример:
Производство
vm
строка
успех
Имя виртуальной машины.

Пример:
web-01
vm_guest_ip
строка
успех
Дополнительный IP-адрес сетевой карты.

Пример:
10.10.10.10


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
  • Этот модуль поддерживается Сообществом 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_instance_nic_secondaryip_module.html

Spec-Zone.ru

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