Spec-Zone.ru › Ansible

Модуль community.general.hwc_vpc_eip — создание ресурса VPC/EIP в Huawei Cloud

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.hwc_vpc_eip.

Добавлено в community.general 0.2.0

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

Краткое описание

  • Управление эластичными IP-адресами.

Требования

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

  • keystoneauth1 >= 3.6.0

Параметры

Параметр

Описание

dedicated_bandwidth

dictionary

Задаёт объект выделенной пропускной способности.

charge_mode

string / обязательный

Указывает, рассчитывается ли стоимость пропускной способности по трафику или по её размеру. Значением может быть bandwidth или traffic. Если параметр не задан или представляет собой пустую строку, используется значение по умолчанию bandwidth. Для IPv6-адресов значение параметра по умолчанию — bandwidth за пределами Китая и traffic в Китае.

name

string / обязательный

Задаёт имя пропускной способности. Значение представляет собой строку длиной от 1 до 64 символов, которая может содержать буквы, цифры, подчёркивания (_), дефисы (-) и точки (.).

size

integer / обязательный

Задаёт размер пропускной способности. По умолчанию допустимый диапазон значений — от 1 Мбит/с до 2000 Мбит/с. (Конкретный диапазон может различаться в зависимости от конфигурации региона. Диапазон пропускной способности для каждого региона можно посмотреть в консоли управления.) Минимальный шаг изменения пропускной способности зависит от её диапазона. Подробности приведены ниже.

Минимальный шаг составляет 1 Мбит/с, если допустимый размер пропускной способности находится в диапазоне от 0 до 300 Мбит/с (включая 300 Мбит/с).

Минимальный шаг составляет 50 Мбит/с, если допустимый размер пропускной способности находится в диапазоне от 300 до 1000 Мбит/с (включая 1000 Мбит/с).

Минимальный шаг составляет 500 Мбит/с, если допустимый размер пропускной способности превышает 1000 Мбит/с.

domain

string / обязательный

Имя домена, в рамках которого выполняется операция (Identity v3).

В настоящее время поддерживаются только имена доменов, но не их идентификаторы.

enterprise_project_id

string

Задаёт идентификатор корпоративного проекта.

id

string

Идентификатор управляемого ресурса.

identity_endpoint

string / обязательный

URL для аутентификации Identity.

ip_version

integer

Значением может быть 4 (адрес IPv4) или 6 (адрес IPv6). Если параметр не задан, назначается адрес IPv4.

ipv4_address

string

Задаёт полученный EIP IPv4. Если значение не указано, система назначает EIP автоматически.

password

string / обязательный

Пароль для входа в систему.

port_id

string

Задаёт идентификатор порта. Этот параметр возвращается только в том случае, если с EIP связан частный IP-адрес.

project

string / обязательный

Имя тенанта (Identity v2) или проекта (Identity v3).

В настоящее время поддерживаются только имена проектов, но не их идентификаторы.

region

string

Регион, к которому относится проект.

shared_bandwidth_id

string

Задаёт идентификатор общей пропускной способности.

state

string

Определяет, должен ли указанный объект существовать в Huawei Cloud.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

timeouts

dictionary

Тайм-ауты для каждой операции.

По умолчанию: {}

create

string

Тайм-аут операции создания.

По умолчанию: "5m"

update

string

Тайм-аут операции обновления.

По умолчанию: "5m"

type

string / обязательный

Задаёт тип EIP.

user

string / обязательный

Имя пользователя для входа в систему.

В настоящее время поддерживаются только имена пользователей, но не их идентификаторы.

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Модуль можно запускать в режиме check_mode; в этом случае он возвращает прогноз изменения состояния, не изменяя целевой объект.

diff_mode

Поддержка: отсутствует

В режиме diff возвращает сведения об изменениях (или о возможных изменениях в check_mode).

Примечания

Примечание

  • Для аутентификации можно задать identity_endpoint с помощью переменной окружения ANSIBLE_HWC_IDENTITY_ENDPOINT.
  • Для аутентификации можно задать user с помощью переменной окружения ANSIBLE_HWC_USER.
  • Для аутентификации можно задать password с помощью переменной окружения ANSIBLE_HWC_PASSWORD.
  • Для аутентификации можно задать domain с помощью переменной окружения ANSIBLE_HWC_DOMAIN.
  • Для аутентификации можно задать project с помощью переменной окружения ANSIBLE_HWC_PROJECT.
  • Для аутентификации можно задать region с помощью переменной окружения ANSIBLE_HWC_REGION.
  • Значения переменных окружения используются только в том случае, если значения не заданы в плейбуке.

Примеры

# create an eip and bind it to a port
- name: Create vpc
  hwc_network_vpc:
    cidr: "192.168.100.0/24"
    name: "ansible_network_vpc_test"
  register: vpc
- name: Create subnet
  hwc_vpc_subnet:
    gateway_ip: "192.168.100.32"
    name: "ansible_network_subnet_test"
    dhcp_enable: true
    vpc_id: "{{ vpc.id }}"
    cidr: "192.168.100.0/26"
  register: subnet
- name: Create a port
  hwc_vpc_port:
    subnet_id: "{{ subnet.id }}"
    ip_address: "192.168.100.33"
  register: port
- name: Create an eip and bind it to a port
  community.general.hwc_vpc_eip:
    type: "5_bgp"
    dedicated_bandwidth:
      charge_mode: "traffic"
      name: "ansible_test_dedicated_bandwidth"
      size: 1
    port_id: "{{ port.id }}"

Возвращаемые значения

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

Ключ

Описание

create_time

string

Указывает время (UTC), когда был назначен EIP.

Возвращается: при успешном выполнении

dedicated_bandwidth

dictionary

Задаёт объект выделенной пропускной способности.

Возвращается: при успешном выполнении

charge_mode

string

Указывает, рассчитывается ли стоимость пропускной способности по трафику или по её размеру. Значением может быть bandwidth или traffic. Если параметр не задан или представляет собой пустую строку, используется значение по умолчанию bandwidth. Для IPv6-адресов значение параметра по умолчанию — bandwidth за пределами Китая и traffic в Китае.

Возвращается: при успешном выполнении

id

string

Задаёт идентификатор выделенной пропускной способности.

Возвращается: при успешном выполнении

name

string

Задаёт имя пропускной способности. Значение представляет собой строку длиной от 1 до 64 символов, которая может содержать буквы, цифры, подчёркивания (_), дефисы (-) и точки (.).

Возвращается: при успешном выполнении

size

integer

Задаёт размер пропускной способности. По умолчанию допустимый диапазон значений — от 1 Мбит/с до 2000 Мбит/с. (Конкретный диапазон может различаться в зависимости от конфигурации региона. Диапазон пропускной способности для каждого региона можно посмотреть в консоли управления.) Минимальный шаг изменения пропускной способности зависит от её диапазона. Подробности приведены ниже:.

Минимальный шаг составляет 1 Мбит/с, если допустимый размер пропускной способности находится в диапазоне от 0 до 300 Мбит/с (включая 300 Мбит/с).

Минимальный шаг составляет 50 Мбит/с, если допустимый размер пропускной способности находится в диапазоне от 300 до 1000 Мбит/с (включая 1000 Мбит/с).

Минимальный шаг составляет 500 Мбит/с, если допустимый размер пропускной способности превышает 1000 Мбит/с.

Возвращается: при успешном выполнении

enterprise_project_id

string

Задаёт идентификатор корпоративного проекта.

Возвращается: при успешном выполнении

ip_version

integer

Значением может быть 4 (адрес IPv4) или 6 (адрес IPv6). Если параметр не задан, назначается адрес IPv4.

Возвращается: при успешном выполнении

ipv4_address

string

Задаёт полученный EIP IPv4. Если значение не указано, система назначает EIP автоматически.

Возвращается: при успешном выполнении

ipv6_address

string

Задаёт полученный EIP IPv6.

Возвращается: при успешном выполнении

port_id

string

Задаёт идентификатор порта. Этот параметр возвращается только в том случае, если с EIP связан частный IP-адрес.

Возвращается: при успешном выполнении

private_ip_address

string

Задаёт частный IP-адрес, связанный с EIP. Этот параметр возвращается только в том случае, если с EIP связан частный IP-адрес.

Возвращается: при успешном выполнении

shared_bandwidth_id

string

Задаёт идентификатор общей пропускной способности.

Возвращается: при успешном выполнении

type

string

Задаёт тип EIP.

Возвращается: при успешном выполнении

Авторы

  • Huawei Inc. (@huaweicloud)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Запросить помощь
  • Сообщить об ошибке
  • Предложить функцию
  • Общение

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/hwc_vpc_eip_module.html

Spec-Zone.ru

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