Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции cisco.meraki (версия 2.18.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.
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

auth_key

строка / обязательно

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

host

строка

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

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

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

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

строка

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

Варианты:

  • "tcp"
  • "udp"

public_port

строка

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

public_ip

строка

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

uplink

строка

Физический интерфейс внешней сети, на котором будет поступать трафик.

Варианты:

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

one_to_one

список / элементы=словарь

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

allowed_inbound

список / элементы=словарь

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

allowed_ips

список / элементы=строка

Диапазоны IP-адресов WAN, которым разрешен входной доступ по указанным портам или диапазонам портов, или «любой».

destination_ports

список / элементы=строка

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

protocol

строка

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

Варианты:

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

lan_ip

строка

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

name

строка

Дескриптивное имя для правила.

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

список / элементы=словарь

Список правил переадресации портов.

allowed_ips

список / элементы=строка

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

lan_ip

строка

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

local_port

целое число

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

name

строка

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

protocol

строка

Протокол для переадресации трафика.

Варианты:

  • "tcp"
  • "udp"

public_port

целое число

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

uplink

строка

Физический интерфейс WAN, на котором будет поступать трафик.

Варианты:

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

rate_limit_retry_time

целое число

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

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

state

строка

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

Варианты:

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

subset

список / элементы=строка

Указывает, какие компоненты NAT следует запросить.

Варианты:

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

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

timeout

целое число

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

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

use_https

булево

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

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

Варианты:

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

use_proxy

булево

Если 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.
  • Модули 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

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

Возвращено: success, когда объект NAT 1:много находится в задаче

rules

complex

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

Возвращено: success, когда объект NAT 1:много находится в задаче

portRules

complex

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

Возвращено: success, когда объект NAT 1:много находится в задаче

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:много находится в задаче

Пример: "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:много находится в задаче

Пример: "148.2.5.100"

uplink

string

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

Возвращено: success, когда объект NAT 1:много находится в задаче

Пример: "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, when 1:1 NAT object is in task

Пример: "192.168.128.22"

name

string

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

Возвращено: success, when 1:1 NAT object is in task

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

publicIp

string

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

Возвращено: success, when 1:1 NAT object is in task

Пример: "148.2.5.100"

uplink

string

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

Возвращено: success, when 1:1 NAT object is in task

Пример: "internet1"

port_forwarding

complex

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

Возвращено: success, when port forwarding is in task

rules

complex

Список правил переадресации портов.

Возвращено: success, when port forwarding is in task

allowedIps

list / elements=string

Список IP-адресов для переадресации.

Возвращено: success, when port forwarding is in task

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

lanIp

string

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

Возвращено: success, when port forwarding is in task

Пример: "192.168.128.22"

localPort

integer

Порт назначения для переадресации.

Возвращено: success, when port forwarding is in task

Пример: 443

name

string

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

Возвращено: success, when port forwarding is in task

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

protocol

string

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

Возвращено: success, when port forwarding is in task

Пример: "tcp"

publicPort

integer

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

Возвращено: success, when port forwarding is in task

Пример: 9443

uplink

string

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

Возвращено: success, when port forwarding is in task

Пример: "internet1"

Статус

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

Авторы

  • Kevin Breit (@kbreit)

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

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

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

Spec-Zone.ru

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