cs_instance_nic_secondaryip – Управляет вторичными IP-адресами экземпляра на облаках Apache CloudStack
Новая версия с 2.4.
Описание
- Добавление и удаление вторичных IP-адресов в 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" | Имя раздела в файле конфигурации cloustack.ini. Если не указано, используется переменная среды CLOUDSTACK_REGION. |
| api_secret строка | Секретный ключ API CloudStack. Если не указано, используется переменная среды 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 строка | Имя сети. Необходимо для поиска NIC, если экземпляру назначено несколько сетей. | |
| poll_async логическое |
| Проверять асинхронные задания, пока задание не будет завершено. |
| project строка | Название проекта, в котором развернут экземпляр. | |
| state строка |
| Состояние IP-адреса. |
| vm строка / обязательно | Имя экземпляра. псевдонимы: name | |
| 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
cs_instance_nic_secondaryip:
vm: customer_xy
vm_guest_ip: 10.10.10.10
delegate_to: localhost
# 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
cs_instance_nic_secondaryip:
vm: customer_xy
delegate_to: localhost
- name: Remove a specific IP from the default NIC
cs_instance_nic_secondaryip:
vm: customer_xy
vm_guest_ip: 10.10.10.10
state: absent
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| account строка | успех | Учетная запись, связанная с VM. Пример: пример учетной записи |
| domain строка | успех | Домен, связанный с VM. Пример: пример домена |
| 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. Пример: Производство |
| vm строка | успех | Имя VM. Пример: web-01 |
| vm_guest_ip строка | успех | Вторичный IP-адрес сетевой карты. Пример: 10.10.10.10 |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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_secondaryip_module.html