Spec-Zone.ru › Ansible

Модуль cisco.meraki.meraki_mx_nat — управление правилами NAT в облаке Meraki

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.meraki_mx_nat.

  • УСТАРЕЛО
  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

УСТАРЕЛО

Удалено:

в версии 3.0.0

Причина:

Выпущены обновлённые модули с расширенными возможностями

Альтернатива:

cisco.meraki.networks_appliance_firewall_one_to_many_nat_rules

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

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

Параметры

Параметр

Комментарии

auth_key

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

Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная среды MERAKI_KEY не задана.

host

string

Имя хоста панели управления Meraki.

Можно использовать для доступа к региональным средам Meraki, например в Китае.

По умолчанию: "api.meraki.com"

internal_error_retry_time

integer

Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку.

По умолчанию: 60

net_id

string

Идентификатор сети.

net_name

псевдонимы: name, network

string

Название сети.

one_to_many

list / элементы=dictionary

Список NAT-правил 1:многие.

port_rules

list / элементы=dictionary

Список связанных правил для портов.

allowed_ips

list / элементы=string

Удалённые IP-адреса или диапазоны, которым разрешён доступ к внутреннему ресурсу через это правило перенаправления портов, либо «any».

local_ip

string

Локальный IP-адрес, на который будет перенаправляться трафик.

local_port

string

Порт назначения пересылаемого трафика, который будет отправлен с MX указанному хосту в LAN.

Если требуется перенаправить трафик без преобразования порта, это значение должно совпадать со значением Public port.

name

string

Описание правила.

protocol

string

Протокол, к которому применяется правило NAT.

Варианты:

  • "tcp"
  • "udp"

public_port

string

Порт назначения трафика, поступающего через WAN.

public_ip

string

IP-адрес, который будет использоваться для доступа к внутреннему ресурсу из WAN.

uplink

string

Физический интерфейс WAN, через который поступает трафик.

Варианты:

  • "both"
  • "internet1"
  • "internet2"

one_to_one

list / элементы=dictionary

Список NAT-правил 1:1.

allowed_inbound

list / элементы=dictionary

Порты, через которые это сопоставление предоставляет доступ, и удалённые IP-адреса, которым разрешён доступ к ресурсу.

allowed_ips

list / элементы=string

Диапазоны IP-адресов WAN, с которых разрешено устанавливать входящие соединения через указанные порты или диапазоны портов, либо «any».

destination_ports

list / элементы=string

Список портов или диапазонов портов, которые будут перенаправляться на хост в LAN.

protocol

string

Протокол, к которому применяется правило NAT.

Варианты:

  • "any" ← (по умолчанию)
  • "icmp-ping"
  • "tcp"
  • "udp"

lan_ip

string

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

name

string

Понятное название правила.

public_ip

string

IP-адрес, который будет использоваться для доступа к внутреннему ресурсу из WAN.

uplink

string

Физический интерфейс WAN, через который поступает трафик.

Варианты:

  • "both"
  • "internet1"
  • "internet2"

org_id

string

Идентификатор организации, связанной с сетью.

org_name

псевдонимы: organization

string

Название организации.

output_format

string

Указывает модулю, должны ли ключи ответа быть в формате snake case (например, net_id) или camel case (например, netId).

Варианты:

  • "snakecase" ← (по умолчанию)
  • "camelcase"

output_level

string

Задаёт объём отладочных данных во время выполнения модуля.

Варианты:

  • "debug"
  • "normal" ← (по умолчанию)

port_forwarding

list / элементы=dictionary

Список правил перенаправления портов.

allowed_ips

list / элементы=string

Список диапазонов IP-адресов WAN, с которых разрешено устанавливать входящие соединения через указанные порты или диапазоны портов (либо любые порты).

lan_ip

string

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

local_port

integer

Порт или диапазон портов, на которые будет перенаправляться трафик из WAN.

name

string

Понятное название правила.

protocol

string

Протокол, для которого перенаправляется трафик.

Варианты:

  • "tcp"
  • "udp"

public_port

integer

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

uplink

string

Физический интерфейс WAN, через который поступает трафик.

Варианты:

  • "both"
  • "internet1"
  • "internet2"

rate_limit_retry_time

integer

Количество секунд до повторной попытки при срабатывании ограничения частоты запросов.

По умолчанию: 165

state

string

Создать или изменить организацию.

Варианты:

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

subset

list / элементы=string

Указывает, какие компоненты NAT запрашивать.

Варианты:

  • "1:1"
  • "1:many"
  • "all" ← (по умолчанию)
  • "port_forwarding"

По умолчанию: ["all"]

timeout

integer

Время ожидания ответа для HTTP-запросов.

По умолчанию: 30

use_https

boolean

Если no, будет использоваться HTTP. В противном случае будет использоваться HTTPS.

Полезно только для внутренних разработчиков Meraki.

Варианты:

  • false
  • true ← (по умолчанию)

use_proxy

boolean

Если no, прокси использоваться не будет, даже если он задан в переменной среды на целевых хостах.

Варианты:

  • false ← (по умолчанию)
  • true

validate_certs

boolean

Проверять ли сертификаты HTTP.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Дополнительную информацию об API Meraki можно найти на странице https://dashboard.meraki.com/api_docs.
  • Некоторые параметры, вероятно, предназначены только для разработчиков Meraki.
  • Начиная с Ansible 2.9 модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, задайте для переменной среды ANSIBLE_MERAKI_FORMAT значение camelcase.
  • В Ansible 2.13 модули Meraki для Ansible перестанут поддерживать вывод в формате camel case. Обновите свои плейбуки.
  • Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загруженной конфигурацией. Режим проверки сообщит об изменениях, если конфигурации различаются, но не отправляет изменения в API для их проверки.

Примеры

- 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

Информация об объекте NAT 1:many.

Возвращается: success, если задача содержит объект NAT 1:many

rules

complex

Список правил NAT 1:many.

Возвращается: success, если задача содержит объект NAT 1:many

portRules

complex

Список правил NAT для портов.

Возвращается: success, если задача содержит объект NAT 1:many

allowedIps

list / elements=string

Список IP-адресов, на которые будет перенаправляться трафик.

Возвращается: success, если задача содержит объект NAT 1:1

Пример: ["10.80.100.0/24"]

localIp

string

Локальный IP-адрес, на который будет перенаправляться трафик.

Возвращается: success, если задача содержит объект NAT 1:1

Пример: "192.0.2.10"

localPort

integer

Порт назначения, на который будет перенаправляться трафик.

Возвращается: success, если задача содержит объект NAT 1:1

Пример: 443

name

string

Имя объекта NAT.

Возвращается: success, если задача содержит объект NAT 1:many

Пример: "Web server behind NAT"

protocol

string

Протокол, для которого применяется правило NAT.

Возвращается: success, если задача содержит объект NAT 1:1

Пример: "tcp"

publicPort

integer

Порт назначения трафика, поступающего через WAN.

Возвращается: success, если задача содержит объект NAT 1:1

Пример: 9443

publicIp

string

Публичный IP-адрес для сопоставления.

Возвращается: success, если задача содержит объект NAT 1:many

Пример: "148.2.5.100"

uplink

string

Интернет-порт, к которому применяется правило.

Возвращается: success, если задача содержит объект NAT 1:many

Пример: "internet1"

one_to_one

complex

Информация об объекте NAT 1:1.

Возвращается: success, если задача содержит объект NAT 1:1

rules

complex

Список правил NAT 1:1.

Возвращается: success, если задача содержит объект NAT 1:1

allowedInbound

complex

Список правил перенаправления входящего трафика.

Возвращается: success, если задача содержит объект NAT 1:1

allowedIps

list / elements=string

Список IP-адресов, на которые будет перенаправляться трафик.

Возвращается: success, если задача содержит объект NAT 1:1

Пример: ["10.80.100.0/24"]

destinationPorts

string

Порты, к которым применяется правило NAT.

Возвращается: success, если задача содержит объект NAT 1:1

Пример: "80"

protocol

string

Протокол, для которого применяется правило NAT.

Возвращается: success, если задача содержит объект NAT 1:1

Пример: "tcp"

lanIp

string

Локальный IP-адрес для сопоставления.

Возвращается: success, если задача содержит объект NAT 1:1

Пример: "192.168.128.22"

name

string

Имя объекта NAT.

Возвращается: success, если задача содержит объект NAT 1:1

Пример: "Web server behind NAT"

publicIp

string

Публичный IP-адрес для сопоставления.

Возвращается: success, если задача содержит объект NAT 1:1

Пример: "148.2.5.100"

uplink

string

Интернет-порт, к которому применяется правило.

Возвращается: success, если задача содержит объект NAT 1:1

Пример: "internet1"

port_forwarding

complex

Информация о правилах перенаправления портов.

Возвращается: success, если задача содержит перенаправление портов

rules

complex

Список правил перенаправления портов.

Возвращается: success, если задача содержит перенаправление портов

allowedIps

list / elements=string

Список IP-адресов, на которые будет перенаправляться трафик.

Возвращается: success, если задача содержит перенаправление портов

Пример: ["10.80.100.0/24"]

lanIp

string

Локальный IP-адрес для сопоставления.

Возвращается: success, если задача содержит перенаправление портов

Пример: "192.168.128.22"

localPort

integer

Порт назначения, на который будет перенаправляться трафик.

Возвращается: success, если задача содержит перенаправление портов

Пример: 443

name

string

Имя объекта NAT.

Возвращается: success, если задача содержит перенаправление портов

Пример: "Web server behind NAT"

protocol

string

Протокол, для которого применяется правило NAT.

Возвращается: success, если задача содержит перенаправление портов

Пример: "tcp"

publicPort

integer

Порт назначения трафика, поступающего через WAN.

Возвращается: success, если задача содержит перенаправление портов

Пример: 9443

uplink

string

Интернет-порт, к которому применяется правило.

Возвращается: success, если задача содержит перенаправление портов

Пример: "internet1"

Статус

  • Этот модуль будет удалён в версии 3.0.0. [устарел]
  • Дополнительные сведения см. в разделе УСТАРЕВШИЙ.

Авторы

  • Kevin Breit (@kbreit)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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/cisco/meraki/meraki_mx_nat_module.html

Spec-Zone.ru

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