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 строка / обязательно		Имя экземпляра. алиасы: name
vm_guest_ip строка		Дополнительный IP-адрес, который нужно добавить к интерфейсу сетевой карты экземпляра. Если не задано, API всегда возвращает новый IP-адрес, и идемпотентность не гарантируется. алиасы: secondary_ip
vpc строка		Имя VPC, к которому относится экземпляр.
zone строка		Имя зоны, в которой развернут экземпляр. Если не задано, используется зона по умолчанию.

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация считывается из нескольких источников в указанном порядке. Переменные среды CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. Переменная среды CLOUDSTACK_TIMEOUT, указывающая на файл CLOUDSTACK_CONFIG. Файл cloudstack.ini в текущей рабочей директории. Файл .cloudstack.ini в домашней директории пользователя. Допускается указание нескольких учетных данных и конечных точек с помощью разделов ini в файле cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию используется раздел cloudstack. Дополнительная информация на странице https://github.com/exoscale/cs.
Подробное руководство по модулям cloudstack можно найти в руководстве CloudStack Cloud Guide.
Этот модуль поддерживает режим проверки.

Примеры

- name: Assign a specific IP to the default NIC of the VM
  cs_instance_nic_secondaryip:
    vm: customer_xy
    vm_guest_ip: 10.10.10.10
  delegate_to: localhost

# 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
  cs_instance_nic_secondaryip:
    vm: customer_xy
  delegate_to: localhost

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

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

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

Ключ	Возвращаемое значение	Описание
account строка	успех	Аккаунт, к которому относится ВМ. Пример: example account
domain строка	успех	Домен, к которому относится ВМ. Пример: example 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 строка	успех	Имя сети, если она не является стандартной. Пример: sync network
project строка	успех	Имя проекта, к которому относится ВМ. Пример: Production
vm строка	успех	Имя ВМ. Пример: web-01
vm_guest_ip строка	успех	Дополнительный IP-адрес сетевого адаптера. Пример: 10.10.10.10

Статус

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

Авторы

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.9/modules/cs_instance_nic_secondaryip_module.html