cs_vlan_ip_range – Управляет диапазонами IP-адресов VLAN на облаках на основе Apache CloudStack

Новое в версии 2.8.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Создание и удаление диапазона IP-адресов VLAN.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account строка		Аккаунт, владелец VLAN. Взаимоисключающий с параметром project.
api_http_method строка	Варианты: get post	Метод 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, также см. примечания.
cidr_ipv6 строка		CIDR IPv6 сети, должен быть не менее /64.
domain строка		Домен аккаунта, владеющего VLAN.
end_ip строка		Конечный IPv4 адрес в диапазоне IP VLAN. Если не указано, используется значение start_ip. Используется только при создании.
end_ipv6 строка		Конечный IPv6 адрес в диапазоне IPv6 сети. Если не указано, используется значение start_ipv6. Используется только при создании.
for_virtual_network логическое	Варианты: нет ← да	`yes` если VLAN виртуального типа, `no` если прямой. Если установлено значение `yes`, но ни physical_network, ни network не заданы, CloudStack попытается добавить диапазон VLAN в физическую сеть с типом трафика Public.
gateway строка		Шлюз диапазона IP VLAN. Требуется, если state=present.
gateway_ipv6 строка		Шлюз IPv6 сети. Используется только при создании.
netmask строка		Маска подсети диапазона IP VLAN. Требуется, если state=present.
network строка		Имя или ID сети. Требуется, если for_virtual_network и physical_network не установлены.
physical_network строка		Имя или ID физической сети.
project строка		Проект, владелец VLAN. Взаимоисключающий с параметром account.
start_ip строка / обязательно		Начальный IPv4 адрес в диапазоне IP VLAN. Используется только при создании.
start_ipv6 строка		Начальный IPv6 адрес в диапазоне IPv6 сети. Используется только при создании.
state строка	Варианты: present ← absent	Состояние диапазона IP сети.
vlan строка		ID или VID сети. Если не указано, используется VLAN сети по умолчанию.
zone строка		ID зоны диапазона IP VLAN. Если не указано, используется зона по умолчанию.

Примечания

Примечание

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: create a VLAN IP range for network test
  cs_vlan_ip_range:
    network: test
    vlan: 98
    start_ip: 10.2.4.10
    end_ip: 10.2.4.100
    gateway: 10.2.4.1
    netmask: 255.255.255.0
    zone: zone-02
  delegate_to: localhost

- name: remove a VLAN IP range for network test
  cs_vlan_ip_range:
    state: absent
    network: test
    start_ip: 10.2.4.10
    end_ip: 10.2.4.100
    zone: zone-02
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
account строка	если доступно	Аккаунт, владелец сети. Пример: example account
cidr_ipv6 строка	если доступно	CIDR IPv6 сети. Пример: 2001:db8::/64
domain строка	успех	Имя домена диапазона IP-адресов VLAN. Пример: ROOT
end_ip строка	успех	Конечный IP-адрес диапазона IP-адресов VLAN. Пример: 10.2.4.100
end_ipv6 строка	если доступно	Конечный IPv6-адрес диапазона IP-адресов VLAN. Пример: 2001:db8::50
for_systemvms булево	успех	Является ли диапазон IP-адресов VLAN выделенным для системных виртуальных машин.
for_virtual_network булево	успех	Является ли диапазон IP-адресов VLAN виртуального типа.
gateway строка	успех	IPv4 шлюз. Пример: 10.2.4.1
gateway_ipv6 строка	если доступно	IPv6 шлюз. Пример: 2001:db8::1
id строка	успех	UUID диапазона IP-адресов VLAN. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6
netmask строка	успех	IPv4 маска подсети. Пример: 255.255.255.0
network строка	если доступно	Сеть диапазона vlan. Пример: test
physical_network строка	успех	Физическая сеть, к которой принадлежит диапазон IP-адресов VLAN. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6
project строка	если доступно	Проект, владелец сети. Пример: example project
start_ip строка	успех	Начальный IP-адрес диапазона IP-адресов VLAN. Пример: 10.2.4.10
start_ipv6 строка	если доступно	Начальный IPv6-адрес диапазона IP-адресов VLAN. Пример: 2001:db8::10
vlan строка	успех	Идентификатор или VID VLAN. Пример: vlan://98
zone строка	успех	Имя зоны. Пример: zone-02

Статус

Этот модуль не гарантирует обратной совместимости. [preview]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

David Passante (@dpassante)

Подсказка

Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 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_vlan_ip_range_module.html