cs_instance_nic_secondaryip — Управляет дополнительными IP-адресами экземпляра в облаках на базе Apache CloudStack.
Новая версия с 2.4.
Обзор
- Добавление и удаление дополнительных IP-адресов к сетевой карте экземпляра.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.6.10
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account | Аккаунт, к которому относится экземпляр. | |
| api_http_method |
| 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 | По умолчанию: yes | Проверка асинхронных задач до завершения. |
| project | Имя проекта, в котором развернут экземпляр. | |
| state |
| Состояние 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 строка | успех | Аккаунт, к которому относится ВМ. Пример: 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 |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Автор
- 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.5/modules/cs_instance_nic_secondaryip_module.html