Spec-Zone.ru › Ansible 2.11

cisco.meraki.meraki_mx_nat – Управление правилами NAT в облаке Meraki

Примечание

Этот плагин входит в коллекцию cisco.meraki (версия 2.2.0).

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

Для использования в плейбуке укажите: cisco.meraki.meraki_mx_nat.

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

Описание

  • Позволяет создавать, управлять и просматривать правила 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 на указанный хост в локальной сети.
Если вы просто хотите перенаправить трафик без перевода порта, он должен быть таким же, как порт общедоступного доступа.
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
строка
    Варианты:
  • любой ←
  • 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:многие
  • все ←
  • port_forwarding
Указывает, какие компоненты NAT необходимо запросить.
timeout
целое число
По умолчанию:
30
Время ожидания для HTTP-запросов.
use_https
логическое
    Варианты:
  • нет
  • да ←
Если no, будет использоваться HTTP. В противном случае будет использоваться HTTPS.
Полезно только для внутренних разработчиков Meraki.
use_proxy
логическое
    Варианты:
  • нет ←
  • да
Если no, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
validate_certs
логическое
    Варианты:
  • нет
  • да ←
Выполнять ли проверку сертификатов HTTP.

Примечания

Примечание

  • Дополнительную информацию об API Meraki можно найти на странице https://dashboard.meraki.com/api_docs.
  • Некоторые параметры, вероятно, используются только разработчиками внутри Meraki.
  • Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake case. Для использования camel case установите переменную среды ANSIBLE_MERAKI_FORMAT в значение camelcase.
  • Модули Meraki Ansible перестанут поддерживать вывод в формате camel case в Ansible 2.13. Пожалуйста, обновите ваши playbook.
  • Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о внесенных изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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
success, когда объект NAT 1:многие в задаче
Информация об объекте NAT 1:многие.
rules
complex
success, когда объект NAT 1:многие в задаче
Список правил NAT 1:многие.
portRules
complex
success, когда объект NAT 1:многие в задаче
Список правил NAT для портов.
allowedIps
list / elements=string
success, когда объект NAT 1:1 в задаче
Список IP-адресов для переадресации.

Пример:
10.80.100.0/24
localIp
string
success, когда объект NAT 1:1 в задаче
Локальный IP-адрес, по которому будет перенаправляться трафик.

Пример:
192.0.2.10
localPort
integer
success, когда объект NAT 1:1 в задаче
Порт назначения, к которому будет перенаправляться трафик.

Пример:
443
name
string
success, когда объект NAT 1:многие в задаче
Имя объекта NAT.

Пример:
Веб-сервер за NAT
protocol
string
success, когда объект NAT 1:1 в задаче
Протокол, к которому применяется правило NAT.

Пример:
tcp
publicPort
integer
success, когда объект NAT 1:1 в задаче
Порт назначения трафика, прибывающего на внешнюю сеть.

Пример:
9443
publicIp
string
success, когда объект NAT 1:многие в задаче
Публичный IP-адрес, который нужно сопоставить.

Пример:
148.2.5.100
uplink
string
success, когда объект NAT 1:многие в задаче
Интернет-порт, к которому применяется правило.

Пример:
internet1
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 / elements=string
success, когда объект NAT 1:1 в задаче
Список IP-адресов для переадресации.

Пример:
10.80.100.0/24
destinationPorts
string
success, когда объект NAT 1:1 в задаче
Порты, к которым применяется правило NAT.

Пример:
80
protocol
string
success, когда объект NAT 1:1 в задаче
Протокол, к которому применяется правило NAT.

Пример:
tcp
lanIp
string
success, когда объект NAT 1:1 в задаче
Локальный IP-адрес, который нужно сопоставить.

Пример:
192.168.128.22
name
string
success, когда объект NAT 1:1 в задаче
Имя объекта NAT.

Пример:
Веб-сервер за NAT
publicIp
string
success, когда объект NAT 1:1 в задаче
Публичный IP-адрес, который нужно сопоставить.

Пример:
148.2.5.100
uplink
string
success, когда объект NAT 1:1 в задаче
Интернет-порт, к которому применяется правило.

Пример:
internet1
port_forwarding
complex
success, когда выполняется переадресация портов
Информация о правилах переадресации портов.
rules
complex
success, когда выполняется переадресация портов
Список правил переадресации портов.
allowedIps
list / elements=string
success, когда выполняется переадресация портов
Список IP-адресов для переадресации.

Пример:
10.80.100.0/24
lanIp
string
success, когда выполняется переадресация портов
Локальный IP-адрес, который нужно сопоставить.

Пример:
192.168.128.22
localPort
integer
success, когда выполняется переадресация портов
Порт назначения, к которому будет перенаправляться трафик.

Пример:
443
name
string
success, когда выполняется переадресация портов
Имя объекта NAT.

Пример:
Веб-сервер за NAT
protocol
string
success, когда выполняется переадресация портов
Протокол, к которому применяется правило NAT.

Пример:
tcp
publicPort
integer
success, когда выполняется переадресация портов
Порт назначения трафика, прибывающего на внешнюю сеть.

Пример:
9443
uplink
string
success, когда выполняется переадресация портов
Интернет-порт, к которому применяется правило.

Пример:
internet1


Авторы

  • Kevin Breit (@kbreit)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/meraki/meraki_mx_nat_module.html

Spec-Zone.ru

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