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"	Имя раздела в файле конфигурации `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	По умолчанию: "yes"	Опрос асинхронных задач до завершения.
project		Имя проекта, в котором развернут экземпляр.
state	Варианты: present ← absent	Состояние ip-адреса.
vm обязательно		Имя экземпляра. Псевдонимы: name
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 строка	success	Аккаунт, связанный с виртуальной машиной. Пример: example account
domain строка	success	Домен, связанный с виртуальной машиной. Пример: example domain
id строка	success	UUID сетевого интерфейса. Пример: 87b1e0ce-4e01-11e4-bb66-0050569e64b8
ip_address строка	success	Основной IP-адрес сетевого интерфейса. Пример: 10.10.10.10
mac_address строка	success	MAC-адрес сетевого интерфейса. Пример: 02:00:33:31:00:e4
netmask строка	success	Маска подсети сетевого интерфейса. Пример: 255.255.255.0
network строка	success	Имя сети, если она не по умолчанию. Пример: sync network
project строка	success	Имя проекта, к которому относится виртуальная машина. Пример: Production
vm строка	success	Имя виртуальной машины. Пример: web-01
vm_guest_ip строка	success	Дополнительный IP-адрес сетевого интерфейса. Пример: 10.10.10.10

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Подробности см. в Поддержка и техническое обслуживание модулей.

Список других модулей, также поддерживаемых сообществом 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.6/modules/cs_instance_nic_secondaryip_module.html