cs_instance_nic_secondaryip — Управляет дополнительными IP-адресами экземпляра в облаках на основе Apache CloudStack.
Новое в версии 2.4.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Добавление и удаление дополнительных IP-адресов в сетевую карту экземпляра.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.6
- cs >= 0.6.10
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| account |
нет | Аккаунт, к которому относится экземпляр. |
||
| api_http_method |
нет | get |
|
Используемый HTTP-метод. |
| api_key |
нет | Ключ API CloudStack API. |
||
| api_region |
нет | cloudstack | Имя раздела ini в файле cloustack.ini. |
|
| api_secret |
нет | Секретный ключ CloudStack API. |
||
| api_timeout |
нет | 10 | Таймаут HTTP. |
|
| api_url |
нет | URL CloudStack API, например, https://cloud.example.com/client/api. |
||
| domain |
нет | Домен, к которому относится экземпляр. |
||
| network |
нет | Имя сети.
Необходимо для поиска сетевой карты, если экземпляру назначено несколько сетей. |
||
| poll_async |
нет | True | Опрашивать асинхронные задачи до завершения. |
|
| project |
нет | Имя проекта, в котором развернут экземпляр. |
||
| state |
нет | present |
|
Состояние IP-адреса. |
| vm |
да | Имя экземпляра.
псевдонимы: name |
||
| vm_guest_ip |
нет | Дополнительный IP-адрес, который нужно добавить к сетевой карте экземпляра.
Если не задано, API всегда возвращает новый IP-адрес, и идемпотентность не гарантируется.
псевдонимы: secondary_ip |
||
| vpc |
нет | Имя VPC, к которому относится vm. |
||
| zone |
нет | Имя зоны, в которой развернут экземпляр.
Если не задано, используется зона по умолчанию. |
Примеры
- 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 |
Примечания
Примечание
- Ansible использует метод конфигурации библиотеки
cs, если учетные данные не предоставлены аргументамиapi_url,api_key,api_secret. Конфигурация считывается из нескольких мест в следующем порядке. —CLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETиCLOUDSTACK_METHODпеременные окружения. — Переменная окруженияCLOUDSTACK_CONFIG, указывающая на файл.ini, — Файлcloudstack.iniв текущей рабочей директории. — Файл.cloudstack.iniв домашней директории пользователя. Допускается указание нескольких учетных данных и конечных точек с использованием разделов ini вcloudstack.ini. Используйте аргументapi_regionдля выбора имени раздела, раздел по умолчанию —cloudstack. Дополнительную информацию см. на странице https://github.com/exoscale/cs. - Подробное руководство по модулям CloudStack можно найти на странице http://docs.ansible.com/ansible/guide_cloudstack.html
- Этот модуль поддерживает режим проверки.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, ознакомьтесь с Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cs_instance_nic_secondaryip_module.html