Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин входит в коллекцию community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: community.aws.ec2_vpc_nat_gateway.

Новое в версии 1.0.0: коллекции community.aws

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

Описание

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

Требования

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

  • boto
  • boto3
  • botocore
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
allocation_id
строка
Идентификатор выделения Elastic IP. Если этот параметр не передан, и параметр eip_address не передан, для данного NAT-шлюза будет сгенерирован EIP.
aws_access_key
строка
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Если задан параметр profile, этот параметр игнорируется.
Передача параметров aws_access_key и profile одновременно устарела, и параметры будут взаимоисключающими после 2022-06-01.

алиасы: ec2_access_key, access_key
aws_ca_bundle
путь
Расположение файла CA-сертификата, используемого для проверки SSL-сертификатов.
Используется только для модулей на основе boto3.
Примечание: CA-сертификат читается со стороны модуля и может потребоваться явное копирование с контроллера, если он не выполняется локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Только ключ 'user_agent' используется для модулей boto. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для дополнительной конфигурации boto.
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Если задан параметр profile, этот параметр игнорируется.
Передача параметров aws_secret_key и profile одновременно устарела, и параметры будут взаимоисключающими после 2022-06-01.

алиасы: ec2_secret_key, secret_key
client_token
строка
Необязательный уникальный токен, используемый при создании для обеспечения идемпотентности. При указании этого параметра обязательно укажите параметр eip_address, в противном случае любые последующие запуски завершатся ошибкой.
debug_botocore_endpoint_logs
логический тип
    Варианты:
  • нет ←
  • да
Использование логирования botocore.endpoint для анализа уникальных (а не общих) API-вызовов "ресурс:действие", выполненных во время задачи, выводящих набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url
строка
URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где необходим регион. Должен быть указан для всех остальных модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если она есть.

алиасы: aws_endpoint_url, endpoint_url
eip_address
строка
Elastic IP-адрес EIP, который вы хотите подключить к этому NAT-шлюзу. Если этот параметр не передан, и параметр allocation_id не передан, для этого NAT-шлюза будет сгенерирован EIP.
if_exist_do_not_create
логический тип
    Варианты:
  • нет ←
  • да
Если NAT-шлюз уже существует в subnet_id, то новый не создается.
nat_gateway_id
строка
Идентификатор NAT-шлюза, динамически назначаемый AWS при создании. Требуется, когда присутствует параметр absent.
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
Использование параметра profile переопределит aws_access_key, aws_secret_key и security_token, а поддержка их одновременного использования с profile устарела.
aws_access_key, aws_secret_key и security_token будут взаимоисключающими с profile после 2022-06-01.

алиасы: aws_profile
region
строка
Регион AWS. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

алиасы: aws_region, ec2_region
release_eip
логический тип
    Варианты:
  • нет ←
  • да
Освободить EIP из VPC.
Параметр действителен только со статусом absent.
Вы должны использовать его с параметром wait. Так как вы не можете освободить адрес во время операции удаления.
security_token
строка
AWS STS токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Если задан параметр profile, этот параметр игнорируется.
Передача параметров security_token и profile одновременно устарела, и параметры будут взаимоисключающими после 2022-06-01.

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

Примечания

Примечание

  • Если параметры не заданы в модуле, могут использоваться следующие переменные среды в порядке убывания приоритета: AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE.
  • 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.
  community.aws.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.
  community.aws.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.
  community.aws.ec2_vpc_nat_gateway:
    state: present
    subnet_id: subnet-12345678
    eip_address: 52.1.1.1
    wait: true
    region: ap-southeast-2
  register: new_nat_gateway

- name: Create new nat gateway and allocate new EIP.
  community.aws.ec2_vpc_nat_gateway:
    state: present
    subnet_id: subnet-12345678
    wait: true
    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.
  community.aws.ec2_vpc_nat_gateway:
    state: present
    subnet_id: subnet-12345678
    wait: true
    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.
  community.aws.ec2_vpc_nat_gateway:
    state: absent
    region: ap-southeast-2
    wait: true
    nat_gateway_id: "{{ item.NatGatewayId }}"
    release_eip: true
  register: delete_nat_gateway_result
  loop: "{{ gateways_to_remove.result }}"

- name: Delete nat gateway and wait for deleted status.
  community.aws.ec2_vpc_nat_gateway:
    state: absent
    nat_gateway_id: nat-12345678
    wait: true
    wait_timeout: 500
    region: ap-southeast-2

- name: Delete nat gateway and release EIP.
  community.aws.ec2_vpc_nat_gateway:
    state: absent
    nat_gateway_id: nat-12345678
    release_eip: true
    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.

Пример:
[{'allocation_id': 'eipalloc-12345', 'network_interface_id': 'eni-12345', 'private_ip': '10.0.0.100', 'public_ip': '52.52.52.52'}]
nat_gateway_id
строка
Во всех случаях.
Идентификатор шлюза VPC NAT.

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

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

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

Пример:
vpc-12345


Авторы

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

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

Spec-Zone.ru

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