gcp_compute_network – Создаёт сеть GCP
Новая в версии 2.6.
Обзор
- Управляет ресурсом сети VPC или устаревшей сетью в GCP.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_kind строка / обязательно |
| Тип используемых учетных данных. | |
| auto_create_subnetworks логическое значение |
| Если установлено в `true`, сеть создается в режиме «автоматического создания подсетей» и автоматически создает подсеть для каждого региона по адресному пространству `10.128.0.0/9`. Если установлено в `false`, сеть создается в режиме «настраиваемой подсети», поэтому пользователь может явно подключить ресурсы подсети. | |
| description строка | Необязательное описание этого ресурса. Для изменения этого поля необходимо пересоздать ресурс. | ||
| env_type строка | Указывает, в какой среде Ansible вы выполняете этот модуль. Это не должно устанавливаться, если вы не знаете, что делаете. Это влияет только на строку User Agent для любых запросов к API. | ||
| ipv4_range строка | Если это поле задано, создается устаревшая сеть. Вы больше не сможете создавать устаревшую сеть с 1 февраля 2020 года. См. [документацию по устаревшей сети](https://cloud.google.com/vpc/docs/legacy) для получения дополнительной информации. Диапазон внутренних адресов, допустимых в этой устаревшей сети. Этот диапазон — спецификация CIDR, например: `192.168.0.0/16`. Для изменения этого поля необходимо пересоздать ресурс. | ||
| name строка / обязательно | Имя ресурса. Предоставляется клиентом при создании ресурса. Имя должно иметь длину от 1 до 63 символов и соответствовать RFC1035. Точнее, имя должно иметь длину от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы должны быть дефисом, строчной буквой или цифрой, за исключением последнего символа, который не может быть дефисом. | ||
| project строка | Проект Google Cloud Platform, который нужно использовать. | ||
| routing_config словарь добавлено в 2.8 | Конфигурация маршрутизации на уровне сети для этой сети. Используется маршрутизатором Cloud для определения типа поведения маршрутизации на всей сети. | ||
| routing_mode строка / обязательно | Режим маршрутизации на всей сети. Если задано `REGIONAL`, маршрутизаторы облака этой сети будут рекламировать маршруты только с подсетями этой сети в том же регионе, что и маршрутизатор. Если задано `GLOBAL`, маршрутизаторы облака этой сети будут рекламировать маршруты со всеми подсетями этой сети по всем регионам. Некоторые допустимые значения: «REGIONAL», «GLOBAL» | ||
| scopes список | Массив используемых областей. | ||
| service_account_contents jsonarg | Содержимое файла JSON учетной записи службы, либо в виде словаря, либо в виде JSON-строки, которая его представляет. | ||
| service_account_email строка | Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию. | ||
| service_account_file путь | Путь к файлу JSON учетной записи службы, если выбран тип serviceaccount. | ||
| state строка |
| Существует ли заданный объект в GCP | |
Примечания
Примечание
- Ссылка на API: https://cloud.google.com/compute/docs/reference/rest/v1/networks
- Официальная документация: https://cloud.google.com/vpc/docs/vpc
- для аутентификации можно задать service_account_file, используя переменную среды c(gcp_service_account_file).
- для аутентификации можно задать service_account_contents, используя переменную среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
- для аутентификации можно задать service_account_email, используя переменную среды
GCP_SERVICE_ACCOUNT_EMAIL. - для аутентификации можно задать auth_kind, используя переменную среды
GCP_AUTH_KIND. - для аутентификации можно задать scopes, используя переменную среды
GCP_SCOPES. - Значения переменных среды будут использованы только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: create a network
gcp_compute_network:
name: test_object
auto_create_subnetworks: 'true'
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| autoCreateSubnetworks boolean | success | При установке в значение `true`, сеть создается в режиме "автоматическое создание подсетей" и будет автоматически создавать подсеть для каждого региона в диапазоне адресов `10.128.0.0/9`. При установке в значение `false`, сеть создается в режиме "настройка подсети вручную", позволяя пользователю явно подключать ресурсы подсети. | |
| creationTimestamp string | success | Дата и время создания в формате RFC3339. | |
| description string | success | Необязательное описание данного ресурса. Для изменения этого поля необходимо создать новый ресурс. | |
| gateway_ipv4 string | success | Адрес шлюза для маршрутизации по умолчанию из сети. Это значение выбирается GCP. | |
| id integer | success | Уникальный идентификатор ресурса. | |
| ipv4_range string | success | Если это поле указано, создается устаревшая сеть legacy. Вы больше не сможете создавать сеть legacy с 1 февраля 2020 года. Для получения дополнительной информации см. [документацию по устаревшим сетям](https://cloud.google.com/vpc/docs/legacy). Диапазон внутренних адресов, разрешенных в этой устаревшей сети. Этот диапазон — спецификация CIDR, например: `192.168.0.0/16`. Для изменения этого поля необходимо создать новый ресурс. | |
| name string | success | Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать 1-63 символа и соответствовать RFC1035. То есть длина имени должна составлять 1-63 символа и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`, что означает, что первый символ должен быть строчной буквой, а все последующие символы — дефис, строчная буква или цифра, за исключением последнего символа, который не может быть дефисом. | |
| routingConfig complex | success | Конфигурация маршрутизации на уровне сети для этой сети. Используется Cloud Router для определения типа поведения маршрутизации для всей сети. | |
| routingMode string | success | Режим маршрутизации для всей сети. Если установлено значение `REGIONAL`, облачные маршрутизаторы этой сети будут рекламировать только маршруты с подсетями этой сети в том же регионе, что и маршрутизатор. Если установлено значение `GLOBAL`, облачные маршрутизаторы этой сети будут рекламировать маршруты со всеми подсетями этой сети во всех регионах. | |
| subnetworks list | success | Определяемые сервером полные URL-адреса всех подсетей в этой сети. | |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/gcp_compute_network_module.html
