Spec-Zone.ru › Ansible 2.7

ec2_vpc_nat_gateway – Управление NAT-шлюзами AWS VPC.

Новая версия с 2.2.

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

Описание

  • Обеспечение состояния NAT-шлюзов AWS VPC на основе их идентификатора, выделения и идентификаторов подсети.

Требования

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

  • boto
  • boto3
  • botocore
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
allocation_id
-
Идентификатор выделения 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-адрес эластичного IP-адреса, который вы хотите подключить к этому NAT-шлюзу. Если этот параметр не указан и параметр allocation_id также не указан, для этого NAT-шлюза будет сгенерирован новый IP-адрес.
if_exist_do_not_create
-
По умолчанию:
"нет"
Если NAT-шлюз уже существует в подсети subnet_id, новый шлюз не создается.
nat_gateway_id
-
Идентификатор, динамически назначаемый 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
-
По умолчанию:
"да"
Освободить эластический IP-адрес из VPC.
Параметр действителен только для состояния absent.
Рекомендуется использовать вместе с параметром wait. Поскольку невозможно освободить адрес во время операции удаления.
security_token
-
добавлено в 1.6
Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
state
-
    Варианты:
  • present ←
  • absent
Убедиться, что NAT-шлюз присутствует или отсутствует.
subnet_id
-
Идентификатор подсети, в которой должен быть создан NAT-шлюз. Требуется при использовании опции present.
validate_certs
boolean
добавлено в 1.5
    Варианты:
  • нет
  • да ←
При значении "нет" сертификаты SSL для boto версий >= 2.6.0 не проверяются.
wait
-
По умолчанию:
"нет"
Ожидание завершения операции перед возвратом.
wait_timeout
-
По умолчанию:
300
Время ожидания завершения операции в секундах перед истечением времени ожидания.

Примечания

Примечание

  • Если параметры не заданы в модуле, следующие переменные среды могут быть использованы в порядке убывания приоритета 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), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION обычно используются для указания AWS региона, когда это необходимо, но это также можно настроить в конфигурационном файле boto

Примеры

# 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
строка
Во всех случаях.
Идентификатор NAT-шлюза VPC.

Пример:
nat-0d1e3a878585988f8
state
строка
Во всех случаях.
Текущее состояние NAT-шлюза.

Пример:
доступно
subnet_id
строка
Во всех случаях.
Идентификатор подсети.

Пример:
subnet-12345
vpc_id
строка
Во всех случаях.
Идентификатор VPC.

Пример:
vpc-12345


Статус

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

Авторы

  • Allen Sanabria (@linuxdynasty)
  • Jon Hadfield (@jonhadfield)
  • Karen Cheng (@Etherdaemon)
END_OF_DOCUMENT_MARKER

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ec2_vpc_nat_gateway_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API