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" | Имя раздела в файле конфигурации 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 bool |
| Ожидать завершения асинхронных задач. |
| project | Имя проекта, в котором развернут экземпляр. | |
| state |
| Состояние сетевого адаптера. |
| vm обязательно | Имя экземпляра. алиасы: имя | |
| 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.
- Этот модуль поддерживает режим проверки.
Примеры
# Add a nic on another network
- local_action:
module: cs_instance_nic
vm: privnet
network: privNetForBasicZone
# Ensure IP address on a nic
- local_action:
module: cs_instance_nic
vm: privnet
ip_address: 10.10.11.32
network: privNetForBasicZone
# Remove a secondary nic
- local_action:
module: cs_instance_nic
vm: privnet
state: absent
network: privNetForBasicZone
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, а ниже представлены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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 |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. в здесь.
Автор
- 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.6/modules/cs_instance_nic_module.html