cs_network – Управляет сетями в облаках на основе Apache CloudStack

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

Описание

Создание, обновление, перезапуск и удаление сетей.

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account строка		Аккаунт, к которому относится сеть.
acl строка добавлен в 2.5		Имя списка управления доступом для уровня сети VPC.
acl_type строка	Варианты: account domain	Тип управления доступом для сети. Если не указано, Cloudstack по умолчанию использует `account` для изолированных сетей и `domain` для общих сетей. Учитывается только при создании.
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. Учитывается только при создании.
clean_up булево	Варианты: нет ← да	Очистка старых элементов сети. Учитывается только при state=restarted.
display_text строка		Текст для отображения сети. Если не указан, используется name как display_text.
domain строка		Домен, к которому относится сеть.
end_ip строка		Конечный IPv4 адрес, к которому принадлежит сеть. Если не указан, используется значение start_ip. Учитывается только при создании.
end_ipv6 строка		Конечный IPv6 адрес, к которому принадлежит сеть. Если не указан, используется значение start_ipv6. Учитывается только при создании.
gateway строка		Шлюз сети. Обязательно для общих сетей и изолированных сетей, принадлежащих VPC. Учитывается только при создании.
gateway_ipv6 -		Шлюз IPv6 сети. Обязательно для общих сетей. Учитывается только при создании.
isolated_pvlan строка		Изолированная частная VLAN для этой сети.
name строка / обязательно		Имя сети (регистрозависимое).
netmask строка		Маска подсети сети. Обязательно для общих сетей и изолированных сетей, принадлежащих VPC. Учитывается только при создании.
network_domain строка		Домен сети.
network_offering строка		Имя предложения для сети. Обязательно, если state=present.
poll_async булево	Варианты: нет да ←	Ожидать завершения асинхронных задач.
project строка		Имя проекта, в котором будет развернута сеть.
start_ip строка		Начальный IPv4 адрес, к которому принадлежит сеть. Учитывается только при создании.
start_ipv6 строка		Начальный IPv6 адрес, к которому принадлежит сеть. Учитывается только при создании.
state строка	Варианты: настоящее ← отсутствует перезапущено	Состояние сети.
subdomain_access булево добавлен в 2.5	Варианты: нет да	Определяет, разрешить ли дочерним доменам использовать сети, выделенные их родительским доменам. Должен использоваться с acl_type=domain. Учитывается только при создании.
tags список добавлен в 2.9		Список тегов. Теги представляют собой список словарей с ключами key и value. Чтобы удалить все теги, задайте пустой список, например, tags: []. псевдонимы: тег
vlan строка		Идентификатор или VID сети.
vpc строка		Имя VPC сети.
zone строка		Имя зоны, в которой должна быть развернута сеть. Если не задано, используется зона по умолчанию.

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация считывается из нескольких мест в следующем порядке. Переменные среды CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT переменная среды, указывающая на файл .ini. Файл cloudstack.ini в текущей рабочей директории. Файл .cloudstack.ini в домашнем каталоге пользователя. Допускается указание нескольких учетных данных и конечных точек с использованием разделов ini в cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию это раздел cloudstack. Дополнительную информацию см. на странице https://github.com/exoscale/cs.
Подробное руководство по модулям cloudstack можно найти в Руководстве по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: Create a network
  cs_network:
    name: my network
    zone: gva-01
    network_offering: DefaultIsolatedNetworkOfferingWithSourceNatService
    network_domain: example.com
  delegate_to: localhost

- name: Create a VPC tier
  cs_network:
    name: my VPC tier 1
    zone: gva-01
    vpc: my VPC
    network_offering: DefaultIsolatedNetworkOfferingForVpcNetworks
    gateway: 10.43.0.1
    netmask: 255.255.255.0
    acl: my web acl
  delegate_to: localhost

- name: Update a network
  cs_network:
    name: my network
    display_text: network of domain example.local
    network_domain: example.local
  delegate_to: localhost

- name: Restart a network with clean up
  cs_network:
    name: my network
    clean_up: yes
    state: restarted
  delegate_to: localhost

- name: Remove a network
  cs_network:
    name: my network
    state: absent
  delegate_to: localhost

Значения возврата

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

Ключ	Возвращаемое значение	Описание
account строка	успех	Аккаунт, к которому относится сеть. Пример: example account
acl строка добавлен в 2.5	успех	Имя списка управления доступом (ACL) для уровня сети VPC. Пример: My ACL
acl_id строка добавлен в 2.5	успех	Идентификатор списка управления доступом (ACL) для уровня сети VPC. Пример: dfafcd55-0510-4b8c-b6c5-b8cedb4cfd88
acl_type строка	успех	Тип доступа сети (Домен, Аккаунт). Пример: Аккаунт
broadcast_domain_type строка	успех	Тип домена широковещательной передачи сети. Пример: Vlan
cidr строка	успех	CIDR IPv4 сети. Пример: 10.101.64.0/24
cidr_ipv6 строка	если доступно	CIDR IPv6 сети. Пример: 2001:db8::/64
display_text строка	успех	Текст отображения сети. Пример: web project
dns1 строка	успех	IP-адрес первого сервера имен. Пример: 1.2.3.4
dns2 строка	успех	IP-адрес второго сервера имен. Пример: 1.2.3.4
domain строка	успех	Домен, к которому относится сеть. Пример: ROOT
gateway строка	успех	IPv4 шлюз. Пример: 10.101.64.1
gateway_ipv6 строка	если доступно	IPv6 шлюз. Пример: 2001:db8::1
id строка	успех	UUID сети. Пример: 04589590-ac63-4ffc-93f5-b698b8ac38b6
is_persistent логический	успех	Является ли сеть постоянной или нет.
is_system логический добавлен в 2.5	успех	Является ли сеть связанной с системой или нет.
name строка	успех	Имя сети. Пример: web project
netmask строка	успех	IPv4 маска сети. Пример: 255.255.255.0
network_domain строка	успех	Домен сети Пример: example.local
network_offering строка	успех	Имя предложения сети. Пример: DefaultIsolatedNetworkOfferingWithSourceNatService
network_offering_availability строка добавлен в 2.5	успех	Доступность предложения сети, из которого создана сеть Пример: Дополнительный
network_offering_conserve_mode логический добавлен в 2.5	успех	Включен ли режим сохранения IP в предложении сети или нет.
network_offering_display_text строка добавлен в 2.5	успех	Текст отображения предложения сети. Пример: Предложение для изолированных сетей VPC с включенной службой Source Nat
project строка	успех	Имя проекта. Пример: Производство
state строка	успех	Состояние сети (Выделено, Реализовано, Настроено). Пример: Выделено
tags список	успех	Список тегов ресурсов, связанных с сетью. Пример: [ { "key": "foo", "value": "bar" } ]
traffic_type строка	успех	Тип трафика сети. Пример: Гость
type строка	успех	Тип сети. Пример: Изолированная
vpc строка	если доступно	Имя VPC. Пример: My VPC
zone строка	успех	Имя зоны. Пример: ch-gva-2

Статус

Данный модуль гарантирует обратную совместимость изменений интерфейса в будущем. [stableinterface]
Этот модуль поддерживается сообществом 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.9/modules/cs_network_module.html