cs_nic - Управляет сетевыми адаптерами и вторичными IP-адресами экземпляра в облаках на базе Apache CloudStack
Новая версия 2.3.
УСТАНОВЛЕНО
| Удалено в Ansible: | |
|---|---|
| версия: 2.8 | |
| Почему: | Создан новый модуль. |
| Альтернатива: | Используйте cs_instance_nic_secondaryip вместо этого. |
Описание
- Добавление и удаление вторичных 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 bool |
| Ожидать завершения асинхронных задач. |
| project | Имя проекта, в котором развернут экземпляр. | |
| state |
| Состояние 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_nic
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_nic
vm: customer_xy
- name: Remove a specific IP from the default NIC
local_action:
module: cs_nic
vm: customer_xy
vm_guest_ip: 10.10.10.10
state: absent
Значения возврата
Общие значения возврата описаны в здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| account строка | success | Учетная запись, связанная с виртуальной машиной. Пример: пример учетной записи |
| domain строка | success | Домен, связанный с виртуальной машиной. Пример: пример домена |
| 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 | Имя сети, если она не по умолчанию. Пример: синхронная сеть |
| project строка | success | Имя проекта, к которому относится виртуальная машина. Пример: Производство |
| vm строка | success | Имя виртуальной машины. Пример: web-01 |
| vm_guest_ip строка | success | Вторичный IP-адрес сетевого адаптера. Пример: 10.10.10.10 |
Статус
Этот модуль помечен как устаревший и будет удален в версии 2.8. Дополнительную информацию см. в разделе УСТАНОВЛЕНО.
Автор
- 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_nic_module.html