Spec-Zone.ru › Ansible 2.9

ec2_eni – Создание и (необязательно) подключение Elastic Network Interface (ENI) к экземпляру

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

Описание

  • Создаёт и (необязательно) подключает Elastic Network Interface (ENI) к экземпляру. Если указан ID ENI или private_ip, существующий ENI (если таковой имеется) будет изменён. Параметр «attached» управляет состоянием подключения сетевого интерфейса.

Требования

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

  • python >= 2.6
  • boto

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
allow_reassignment
boolean
добавлен в 2.7
    Варианты:
  • нет ←
  • да
Указывает, разрешить ли повторное назначение IP-адреса, который уже назначен другому сетевому интерфейсу или экземпляру, указанному сетевому интерфейсу.
attached
boolean
    Варианты:
  • нет
  • да
Указывает, следует ли подключать или отключать сетевой интерфейс от экземпляра. Если опущено, состояние подключения не изменится.
aws_access_key
string
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

псевдонимы: ec2_access_key, access_key
aws_secret_key
string
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
добавлен в 2.8
    Варианты:
  • нет ←
  • да
Использовать логгер botocore.endpoint для анализа уникальных (а не общих) вызовов API «ресурс:действие» во время задачи, выводить набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, созданного во время выполнения playbook. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
delete_on_termination
boolean
    Варианты:
  • нет
  • да
Удалить интерфейс при завершении работы экземпляра, к которому он подключён. Этот флаг можно указывать только при модификации интерфейса, а не при его создании.
description
-
Необязательное описание ENI.
device_index
-
По умолчанию:
0
Индекс устройства для подключения сетевого интерфейса к экземпляру.
ec2_url
string
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не указан, используется значение переменной среды EC2_URL (если имеется).
eni_id
-
ID ENI (для модификации); если null и state присутствует, будет создан новый ENI.
force_detach
boolean
    Варианты:
  • нет ←
  • да
Принудительно отсоединить интерфейс. Это относится к случаям явного отключения интерфейса путём установки instance_id в None или при удалении интерфейса со state=absent.
instance_id
-
ID экземпляра, к которому вы хотите подключить ENI. С версии 2.2 используйте параметр «attached» для подключения или отключения ENI. До версии 2.2 для отключения ENI от экземпляра используйте «None».
private_ip_address
-
Приватный IP-адрес.
profile
string
Использует профиль boto. Работает только с boto >= 2.24.0.
purge_secondary_private_ip_addresses
boolean
добавлен в 2.5
    Варианты:
  • нет ←
  • да
Используется с secondary_private_ip_addresses, чтобы определить, удалять ли вторичные IP-адреса, кроме указанных. Установите secondary_private_ip_addresses в пустой список, чтобы удалить все вторичные адреса.
region
string
AWS регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION (если имеется). См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

псевдонимы: aws_region, ec2_region
secondary_private_ip_address_count
-
Количество вторичных IP-адресов для назначения сетевому интерфейсу. Этот параметр несовместим с secondary_private_ip_addresses
secondary_private_ip_addresses
-
Список IP-адресов для назначения в качестве вторичных IP-адресов сетевому интерфейсу. Этот параметр несовместим с secondary_private_ip_address_count
security_groups
-
Список групп безопасности, связанных с интерфейсом. Используется только при state=present. С версии 2.2 можно указать группы безопасности по ID или имени или их комбинации. До версии 2.2 можно указывать только по ID.
security_token
string
AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

псевдонимы: access_token
source_dest_check
boolean
    Варианты:
  • нет
  • да
По умолчанию интерфейсы выполняют проверки источника/назначения. Однако экземпляры NAT нуждаются в отключении этой проверки. Этот флаг можно указывать только при модификации интерфейса, а не при его создании.
state
-
    Варианты:
  • present ←
  • absent
Создать или удалить ENI
subnet_id
-
ID подсети, в которой создать ENI.
validate_certs
boolean
    Варианты:
  • нет
  • да ←
Если установлено в "нет", сертификаты SSL для boto версий >= 2.6.0 не будут проверяться.

Примечания

Примечание

  • Этот модуль идентифицирует ENI на основе eni_id, комбинации private_ip_address и subnet_id или комбинации instance_id и device_id. Любой из этих вариантов позволит указать конкретный ENI.
  • Если параметры не заданы в модуле, следующие переменные окружения могут быть использованы в порядке убывания приоритета 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.

# Create an ENI. As no security group is defined, ENI will be created in default security group
- ec2_eni:
    private_ip_address: 172.31.0.20
    subnet_id: subnet-xxxxxxxx
    state: present

# Create an ENI and attach it to an instance
- ec2_eni:
    instance_id: i-xxxxxxx
    device_index: 1
    private_ip_address: 172.31.0.20
    subnet_id: subnet-xxxxxxxx
    state: present

# Create an ENI with two secondary addresses
- ec2_eni:
    subnet_id: subnet-xxxxxxxx
    state: present
    secondary_private_ip_address_count: 2

# Assign a secondary IP address to an existing ENI
# This will purge any existing IPs
- ec2_eni:
    subnet_id: subnet-xxxxxxxx
    eni_id: eni-yyyyyyyy
    state: present
    secondary_private_ip_addresses:
      - 172.16.1.1

# Remove any secondary IP addresses from an existing ENI
- ec2_eni:
    subnet_id: subnet-xxxxxxxx
    eni_id: eni-yyyyyyyy
    state: present
    secondary_private_ip_address_count: 0

# Destroy an ENI, detaching it from any instance if necessary
- ec2_eni:
    eni_id: eni-xxxxxxx
    force_detach: yes
    state: absent

# Update an ENI
- ec2_eni:
    eni_id: eni-xxxxxxx
    description: "My new description"
    state: present

# Update an ENI identifying it by private_ip_address and subnet_id
- ec2_eni:
    subnet_id: subnet-xxxxxxx
    private_ip_address: 172.16.1.1
    description: "My new description"

# Detach an ENI from an instance
- ec2_eni:
    eni_id: eni-xxxxxxx
    instance_id: None
    state: present

### Delete an interface on termination
# First create the interface
- ec2_eni:
    instance_id: i-xxxxxxx
    device_index: 1
    private_ip_address: 172.31.0.20
    subnet_id: subnet-xxxxxxxx
    state: present
  register: eni

# Modify the interface to enable the delete_on_terminaton flag
- ec2_eni:
    eni_id: "{{ eni.interface.id }}"
    delete_on_termination: true

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

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

Ключ Возвращаемое значение Описание
interface
complex
when state != absent
Атрибуты сетевого интерфейса

description
string
Описание интерфейса

Пример:
Сетевой интерфейс брандмауэра
groups
список словарей
Список групп безопасности

Пример:
[{'sg-f8a8a9da': 'default'}]
id
строка
Идентификатор сетевого интерфейса

Пример:
eni-1d889198
mac_address
строка
Физический адрес интерфейса

Пример:
00:00:5E:00:53:23
owner_id
строка
Идентификатор учетной записи AWS

Пример:
812381371
private_ip_address
строка
Основной IP-адрес этого интерфейса

Пример:
10.20.30.40
private_ip_addresses
список словарей
Список всех частных IP-адресов, связанных с этим интерфейсом

Пример:
[{'primary_address': True, 'private_ip_address': '10.20.30.40'}]
source_dest_check
boolean
Значение флага проверки источника/назначения

Пример:
True
status
строка
Статус сетевого интерфейса

Пример:
pending
subnet_id
строка
В какой подсети VPC привязан интерфейс

Пример:
subnet-b0a0393c
vpc_id
строка
В какой VPC привязан этот сетевой интерфейс

Пример:
vpc-9a9a9da


Статус

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

Авторы

  • Rob White (@wimnat)

Подсказка

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

© 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/ec2_eni_module.html

Spec-Zone.ru

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