cs_instance_nic – Управляет сетевыми интерфейсами (NIC) виртуальной машины на облачных платформах на базе Apache CloudStack.
Новая версия с 2.4.
Обзор
- Добавление и удаление сетевых интерфейсов (NIC) к сети
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется данный модуль.
- 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 boolean |
| Ожидать завершения асинхронных задач. |
| 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 строка | успех | Аккаунт, к которому относится виртуальная машина. Пример: 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 |
Статус
- Гарантия обратной совместимости интерфейса не предоставляется. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/cs_instance_nic_module.html