cs_instance_nic – Управляет сетевыми адаптерами экземпляра в облаках на основе Apache CloudStack
Новое в версии 2.4.
Обзор
- Добавление и удаление сетевого адаптера в сеть
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 строка | Домен, связанный с экземпляром. | |
| ip_address строка | IP-адрес, который будет использоваться для сетевого адаптера. | |
| network строка / обязательно | Имя сети. | |
| poll_async логический тип |
| Опрашивать асинхронные задания, пока задание не завершится. |
| project строка | Имя проекта, в котором развернут экземпляр. | |
| state строка |
| Состояние сетевого адаптера. |
| vm строка / обязательно | Имя экземпляра. псевдонимы: name | |
| 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: Add a nic on another network
cs_instance_nic:
vm: privnet
network: privNetForBasicZone
delegate_to: localhost
- name: Ensure IP address on a nic
cs_instance_nic:
vm: privnet
ip_address: 10.10.11.32
network: privNetForBasicZone
delegate_to: localhost
- name: Remove a secondary nic
cs_instance_nic:
vm: privnet
state: absent
network: privNetForBasicZone
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращенное значение | Описание |
|---|---|---|
| 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 |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Marc-Aurèle Brothier (@marcaurele)
- 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.8/modules/cs_instance_nic_module.html