meraki_nat – Управление правилами NAT в облаке Meraki

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

Описание
Параметры
Примечания
Примеры
Значения возврата
Статус

Описание

Позволяет создавать, управлять и просматривать правила NAT (1:1, 1:многие, переадресация портов) в Meraki.

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательно				Ключ аутентификации, предоставленный на панели управления. Требуется, если переменная окружения `MERAKI_KEY` не задана.
host строка			По умолчанию: "api.meraki.com"	Имя хоста панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число			По умолчанию: 60	Количество секунд для повторной попытки, если сервер вернул ошибку внутренней системы.
net_id строка				Идентификационный номер сети.
net_name строка				Название сети. псевдонимы: name, network
one_to_many список				Список правил NAT 1:многие.
	port_rules список			Список связанных правил портов.
		allowed_ips список		Удаленные IP-адреса или диапазоны, которым разрешен доступ к внутреннему ресурсу через это правило переадресации портов, или «любой».
		local_ip строка		Локальный IP-адрес, на который будет перенаправлен трафик.
		local_port строка		Порт назначения перенаправленного трафика, который будет отправлен с MX на указанный хост в локальной сети. Если вы просто хотите перенаправить трафик без преобразования порта, он должен быть таким же, как порт Public.
		name строка		Описание правила.
		protocol строка	Варианты: tcp udp	Протокол для применения правила NAT.
		public_port строка		Порт назначения трафика, прибывающего по внешнему каналу.
	public_ip строка			IP-адрес, который будет использоваться для доступа к внутреннему ресурсу из внешней сети.
	uplink строка		Варианты: both internet1 internet2	Физический интерфейс внешней сети, на котором будет прибывать трафик.
one_to_one список				Список правил NAT 1:1.
	allowed_inbound список			Порты, которые обеспечат доступ к этому отображению, и удаленные IP-адреса, которым будет разрешен доступ к ресурсу.
		allowed_ips список		Диапазоны IP-адресов внешней сети, которым разрешено устанавливать входящие подключения на указанные порты или диапазоны портов, или «любой».
		destination_ports список		Список портов или диапазонов портов, которые будут перенаправлены на хост в локальной сети.
		protocol строка	Варианты: any ← icmp-ping tcp udp	Протокол для применения правила NAT.
	lan_ip строка			IP-адрес сервера или устройства, на котором размещен внутренний ресурс, который вы хотите сделать доступным во внешней сети.
	name строка			Дескриптивное имя для правила.
	public_ip строка			IP-адрес, который будет использоваться для доступа к внутреннему ресурсу из внешней сети.
	uplink -		Варианты: both internet1 internet2	Физический интерфейс внешней сети, на котором будет прибывать трафик.
org_id строка				Идентификатор организации, связанной с сетью.
org_name строка				Название организации. псевдонимы: organization
output_format строка			Варианты: snakecase ← camelcase	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`).
output_level строка			Варианты: debug normal ←	Устанавливает количество отладочной информации во время выполнения модуля.
port_forwarding список				Список правил переадресации портов.
	allowed_ips -			Список диапазонов IP-адресов внешней сети, которым разрешено устанавливать входящие подключения на указанные порты или диапазоны портов (или любой).
	lan_ip строка			IP-адрес сервера или устройства, на котором размещен внутренний ресурс, который вы хотите сделать доступным во внешней сети.
	local_port строка			Порт или диапазон портов, которые будут получать перенаправленный трафик из внешней сети.
	name строка			Дескриптивное имя для правила.
	protocol строка		Варианты: tcp udp	Протокол для перенаправления трафика.
	public_port строка			Порт или диапазон портов, которые будут перенаправлены на хост в локальной сети.
	uplink строка		Варианты: both internet1 internet2	Физический интерфейс внешней сети, на котором будет прибывать трафик.
rate_limit_retry_time целое число			По умолчанию: 165	Количество секунд для повторной попытки, если срабатывает ограничитель скорости.
state строка			Варианты: present ← query	Создать или изменить организацию.
subset список			Варианты: 1:1 1:many all ← port_forwarding	Указывает, какие компоненты NAT следует запросить.

timeout целое число	Значение по умолчанию: 30	Время ожидания для HTTP-запросов.
use_https булево	Варианты: no yes ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy булево	Варианты: no yes	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах.
validate_certs булево	Варианты: no yes ←	Проверять ли сертификаты HTTP.

Примечания

Примечание

Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только для разработчиков внутри Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake_case. Чтобы использовать camelCase, установите переменную среды ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki Ansible прекратят поддержку вывода camelCase в Ansible 2.13. Пожалуйста, обновите свои плейбуки.

Примеры

- name: Query all NAT rules
  meraki_nat:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
    subset: all
  delegate_to: localhost

- name: Query 1:1 NAT rules
  meraki_nat:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
    subset: '1:1'
  delegate_to: localhost

- name: Create 1:1 rule
  meraki_nat:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    one_to_one:
      - name: Service behind NAT
        public_ip: 1.2.1.2
        lan_ip: 192.168.128.1
        uplink: internet1
        allowed_inbound:
          - protocol: tcp
            destination_ports:
              - 80
            allowed_ips:
              - 10.10.10.10
  delegate_to: localhost

- name: Create 1:many rule
  meraki_nat:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    one_to_many:
      - public_ip: 1.1.1.1
        uplink: internet1
        port_rules:
          - name: Test rule
            protocol: tcp
            public_port: 10
            local_ip: 192.168.128.1
            local_port: 11
            allowed_ips:
              - any
  delegate_to: localhost

- name: Create port forwarding rule
  meraki_nat:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    port_forwarding:
      - name: Test map
        lan_ip: 192.168.128.1
        uplink: both
        protocol: tcp
        allowed_ips:
          - 1.1.1.1
        public_port: 10
        local_port: 11
  delegate_to: localhost

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

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

Ключ					Возвращаемое значение	Описание
data complex					success	Информация об объекте, созданном или измененном.
	one_to_many complex				success, при наличии объекта NAT 1:многие в задаче	Информация об объекте NAT 1:многие.
		rules complex			success, при наличии объекта NAT 1:многие в задаче	Список правил NAT 1:многие.
			portRules complex		success, при наличии объекта NAT 1:многие в задаче	Список правил NAT для портов.
				allowedIps list	success, при наличии объекта NAT 1:1 в задаче	Список IP-адресов для переадресации.
				localIp string	success, при наличии объекта NAT 1:1 в задаче	Локальный IP-адрес, трафик будет перенаправлен с него.
				localPort integer	success, при наличии объекта NAT 1:1 в задаче	Порт назначения для переадресации.
				name string	success, при наличии объекта NAT 1:многие в задаче	Имя объекта NAT.
				protocol string	success, при наличии объекта NAT 1:1 в задаче	Протокол для применения правила NAT.
				publicPort integer	success, при наличии объекта NAT 1:1 в задаче	Порт назначения трафика, приходящего по WAN.
			publicIp string		success, при наличии объекта NAT 1:многие в задаче	Публичный IP-адрес для сопоставления.
			uplink string		success, при наличии объекта NAT 1:многие в задаче	Интернет-порт, где применяется правило.
	one_to_one complex				success, при наличии объекта NAT 1:1 в задаче	Информация об объекте NAT 1:1.
		rules complex			success, при наличии объекта NAT 1:1 в задаче	Список правил NAT 1:1.
			allowedInbound complex		success, при наличии объекта NAT 1:1 в задаче	Список правил входящей переадресации.
				allowedIps list	success, при наличии объекта NAT 1:1 в задаче	Список IP-адресов для переадресации.
				destinationPorts string	success, при наличии объекта NAT 1:1 в задаче	Порты для применения правила NAT.
				protocol string	success, при наличии объекта NAT 1:1 в задаче	Протокол для применения правила NAT.
			lanIp string		success, при наличии объекта NAT 1:1 в задаче	Локальный IP-адрес для сопоставления.
			name string		success, при наличии объекта NAT 1:1 в задаче	Имя объекта NAT.
			publicIp string		success, при наличии объекта NAT 1:1 в задаче	Публичный IP-адрес для сопоставления.
			uplink string		success, при наличии объекта NAT 1:1 в задаче	Интернет-порт, где применяется правило.
	port_forwarding complex				success, при наличии задачи по переадресации портов	Информация о правилах переадресации портов.
		rules complex			success, при наличии задачи по переадресации портов	Список правил переадресации портов.
			allowedIps list		success, при наличии задачи по переадресации портов	Список IP-адресов для переадресации.
			lanIp string		success, при наличии задачи по переадресации портов	Локальный IP-адрес для сопоставления.
			localPort integer		success, при наличии задачи по переадресации портов	Порт назначения для переадресации.
			name string		success, при наличии задачи по переадресации портов	Имя объекта NAT.
			protocol string		success, при наличии задачи по переадресации портов	Протокол для применения правила NAT.
			publicPort integer		success, при наличии задачи по переадресации портов	Порт назначения трафика, приходящего по WAN.
			uplink string		success, при наличии задачи по переадресации портов	Интернет-порт, где применяется правило.

Статус

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

Авторы

Kevin Breit (@kbreit)

Подсказка

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

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