ec2_vpc_nat_gateway — Управление NAT-шлюзами AWS VPC.
Новая версия с 2.2.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Обеспечение состояния NAT-шлюзов AWS VPC на основе их идентификатора, выделения и идентификатора подсети.
Требования (к хосту, на котором выполняется модуль)
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Обязательный | Значение по умолчанию | Варианты | Комментарии |
|---|---|---|---|---|
| allocation_id | нет | None | Идентификатор выделения эластичного IP-адреса. Если этот параметр не передан, а параметр eip_address также не передан, для этого NAT-шлюза будет сгенерирован эластичный IP-адрес. | |
| aws_access_key | нет | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key | ||
| aws_secret_key | нет | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | ||
| client_token | нет | Необязательный уникальный маркер, используемый при создании для обеспечения идемпотентности. При указании этого параметра обязательно укажите параметр eip_address, иначе любые последующие запуски завершатся ошибкой. | ||
| ec2_url | нет | URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она существует. | ||
| eip_address | нет | Эластичный IP-адрес EIP, который нужно прикрепить к этому NAT-шлюзу. Если этот параметр не передан, а параметр allocation_id также не передан, для этого NAT-шлюза будет сгенерирован эластичный IP-адрес. | ||
| if_exist_do_not_create | нет | Если NAT-шлюз уже существует в подсети subnet_id, то новый не создается. | ||
| nat_gateway_id | нет | None | Идентификатор, динамически назначаемый AWS NAT-шлюзу при создании. Требуется, когда присутствует параметр absent. | |
| profile (добавлено в 1.6)
| нет | Использует профиль boto. Работает только с boto >= 2.24.0. | ||
| region | нет | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она существует. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | ||
| release_eip | нет | True | Освободить эластичный IP-адрес из VPC. Параметр действителен только для состояния absent. Рекомендуется использовать вместе с параметром wait. Так как невозможно освободить адрес во время операции удаления. | |
| security_token (добавлено в 1.6)
| нет | AWS STS-токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | ||
| state | нет | present |
| Обеспечить наличие или отсутствие NAT-шлюза. |
| subnet_id | нет | None | Идентификатор подсети, в которой должен быть создан NAT-шлюз. Требуется при использовании параметра present. | |
| validate_certs (добавлено в 1.5)
| нет | да |
| При значении "нет" сертификаты SSL для boto версий >= 2.6.0 не будут проверяться. |
| wait | нет | Ожидать завершения операции перед возвратом. | ||
| wait_timeout | нет | 300 | Количество секунд ожидания завершения операции перед истечением времени ожидания. |
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Create new nat gateway with client token.
ec2_vpc_nat_gateway:
state: present
subnet_id: subnet-12345678
eip_address: 52.1.1.1
region: ap-southeast-2
client_token: abcd-12345678
register: new_nat_gateway
- name: Create new nat gateway using an allocation-id.
ec2_vpc_nat_gateway:
state: present
subnet_id: subnet-12345678
allocation_id: eipalloc-12345678
region: ap-southeast-2
register: new_nat_gateway
- name: Create new nat gateway, using an EIP address and wait for available status.
ec2_vpc_nat_gateway:
state: present
subnet_id: subnet-12345678
eip_address: 52.1.1.1
wait: yes
region: ap-southeast-2
register: new_nat_gateway
- name: Create new nat gateway and allocate new EIP.
ec2_vpc_nat_gateway:
state: present
subnet_id: subnet-12345678
wait: yes
region: ap-southeast-2
register: new_nat_gateway
- name: Create new nat gateway and allocate new EIP if a nat gateway does not yet exist in the subnet.
ec2_vpc_nat_gateway:
state: present
subnet_id: subnet-12345678
wait: yes
region: ap-southeast-2
if_exist_do_not_create: true
register: new_nat_gateway
- name: Delete nat gateway using discovered nat gateways from facts module.
ec2_vpc_nat_gateway:
state: absent
region: ap-southeast-2
wait: yes
nat_gateway_id: "{{ item.NatGatewayId }}"
release_eip: yes
register: delete_nat_gateway_result
with_items: "{{ gateways_to_remove.result }}"
- name: Delete nat gateway and wait for deleted status.
ec2_vpc_nat_gateway:
state: absent
nat_gateway_id: nat-12345678
wait: yes
wait_timeout: 500
region: ap-southeast-2
- name: Delete nat gateway and release EIP.
ec2_vpc_nat_gateway:
state: absent
nat_gateway_id: nat-12345678
release_eip: yes
wait: yes
wait_timeout: 300
region: ap-southeast-2
Возвращаемые значения
Общие значения возвращаемых данных описаны здесь Значения возврата, ниже приведены поля, уникальные для данного модуля:
| Имя | Описание | Возвращается | Тип | Пример |
|---|---|---|---|---|
| create_time | Формат даты и времени ISO 8601 в формате UTC. | Во всех случаях. | строка | 2016-03-05T05:19:20.282000+00:00' |
| nat_gateway_addresses | Список словарей, содержащих public_ip, network_interface_id, private_ip и allocation_id. | Во всех случаях. | строка | [{'public_ip': '52.52.52.52', 'network_interface_id': 'eni-12345', 'private_ip': '10.0.0.100', 'allocation_id': 'eipalloc-12345'}] |
| nat_gateway_id | ID шлюза VPC NAT. | Во всех случаях. | строка | nat-0d1e3a878585988f8 |
| state | Текущее состояние шлюза NAT. | Во всех случаях. | строка | available |
| subnet_id | ID подсети. | Во всех случаях. | строка | subnet-12345 |
| vpc_id | ID VPC. | Во всех случаях. | строка | vpc-12345 |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION - Ansible использует файл конфигурации boto (как правило, ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONможно использовать для указания региона AWS, если это требуется, но это также можно настроить в файле конфигурации boto
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Для получения помощи в разработке модулей, если вы так расположены, ознакомьтесь с Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ec2_vpc_nat_gateway_module.html