Модуль community.general.oneandone_firewall_policy – Настройка брандмауэра 1&1

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

Для использования в playbook, укажите: community.general.oneandone_firewall_policy.

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

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

Создание, удаление, переконфигурация, обновление политик брандмауэра. Этот модуль имеет зависимость от 1and1 >= 1.0.

Требования

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

1and1

Параметры

Параметр	Комментарии
add_rules list / elements=dictionary	Список правил, которые будут добавлены к существующей политике брандмауэра. Синтаксис такой же, как и для параметра rules. Используется в сочетании с состоянием update. По умолчанию: `[]`
add_server_ips list / elements=string	Список идентификаторов серверов (id или имя), которые будут назначены политике брандмауэра. Используется в сочетании с состоянием update. По умолчанию: `[]`
api_url string	Пользовательский URL API. Переопределяет переменную среды ONEANDONE_API_URL.
auth_token string	Токен аутентификации API, предоставленный 1&1.
description string	Описание политики брандмауэра. maxLength=256
firewall_policy string	Идентификатор (id или имя) политики брандмауэра, используемый с состоянием update.
name string	Имя политики брандмауэра, используемое с состоянием present. Используется как идентификатор (id или имя) при использовании с состоянием absent. maxLength=128
remove_rules list / elements=string	Список идентификаторов правил, которые будут удалены из существующей политики брандмауэра. Используется в сочетании с состоянием update. По умолчанию: `[]`
remove_server_ips list / elements=string	Список идентификаторов IP-адресов серверов, которые будут отменены назначению для политики брандмауэра. Используется в сочетании с состоянием update. По умолчанию: `[]`
rules list / elements=dictionary	Список правил, которые будут установлены для политики брандмауэра. Каждое правило должно содержать параметр protocol, а также три необязательных параметра (port_from, port_to и source) По умолчанию: `[]`
state string	Определяет состояние политики брандмауэра для создания, удаления или обновления. Варианты: `"present"` ← (по умолчанию) `"absent"` `"update"`
wait boolean	ждать, пока экземпляр не перейдет в состояние «running», прежде чем возвращать результат Варианты: `false` `true` ← (по умолчанию)
wait_interval integer	Определяет количество секунд ожидания при использовании методов _wait_for По умолчанию: `5`
wait_timeout integer	сколько времени ждать, прежде чем ожидание завершится, в секундах По умолчанию: `600`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз состояния changed без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	Возвращает подробную информацию о том, что изменилось (или, возможно, должно измениться в режиме `check_mode`), когда находится в режиме diff.

Примеры

- name: Create a firewall policy
  community.general.oneandone_firewall_policy:
    auth_token: oneandone_private_api_key
    name: ansible-firewall-policy
    description: Testing creation of firewall policies with ansible
    rules:
     -
       protocol: TCP
       port_from: 80
       port_to: 80
       source: 0.0.0.0
    wait: true
    wait_timeout: 500

- name: Destroy a firewall policy
  community.general.oneandone_firewall_policy:
    auth_token: oneandone_private_api_key
    state: absent
    name: ansible-firewall-policy

- name: Update a firewall policy
  community.general.oneandone_firewall_policy:
    auth_token: oneandone_private_api_key
    state: update
    firewall_policy: ansible-firewall-policy
    name: ansible-firewall-policy-updated
    description: Testing creation of firewall policies with ansible - updated

- name: Add server to a firewall policy
  community.general.oneandone_firewall_policy:
    auth_token: oneandone_private_api_key
    firewall_policy: ansible-firewall-policy-updated
    add_server_ips:
     - server_identifier (id or name)
     - server_identifier #2 (id or name)
    wait: true
    wait_timeout: 500
    state: update

- name: Remove server from a firewall policy
  community.general.oneandone_firewall_policy:
    auth_token: oneandone_private_api_key
    firewall_policy: ansible-firewall-policy-updated
    remove_server_ips:
     - B2504878540DBC5F7634EB00A07C1EBD (server's IP id)
    wait: true
    wait_timeout: 500
    state: update

- name: Add rules to a firewall policy
  community.general.oneandone_firewall_policy:
    auth_token: oneandone_private_api_key
    firewall_policy: ansible-firewall-policy-updated
    description: Adding rules to an existing firewall policy
    add_rules:
     -
       protocol: TCP
       port_from: 70
       port_to: 70
       source: 0.0.0.0
     -
       protocol: TCP
       port_from: 60
       port_to: 60
       source: 0.0.0.0
    wait: true
    wait_timeout: 500
    state: update

- name: Remove rules from a firewall policy
  community.general.oneandone_firewall_policy:
    auth_token: oneandone_private_api_key
    firewall_policy: ansible-firewall-policy-updated
    remove_rules:
     - rule_id #1
     - rule_id #2
     - ...
    wait: true
    wait_timeout: 500
    state: update

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

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

Ключ	Описание
firewall_policy словарь	Информация о политике брандмауэра, которая была обработана Возвращаемое значение: всегда Пример: `{"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Policy"}`

Авторы

Amel Ajdinovic (@aajdinov)
Ethan Devenport (@edevenport)

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

© 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/community/general/oneandone_firewall_policy_module.html