community.network.avi_networksecuritypolicy модуль – Модуль для настройки объекта NetworkSecurityPolicy Avi RESTful

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в книге задач укажите: community.network.avi_networksecuritypolicy.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль используется для настройки объекта NetworkSecurityPolicy
Дополнительные примеры см. на https://github.com/avinetworks/devops

Псевдонимы: network.avi.avi_networksecuritypolicy

Требования

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

avisdk

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сессию.
api_version строка	Версия API Avi для использования Avi API и объектов. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция исправления, используемая при использовании avi_api_update_method как patch. Выбор: `"add"` `"replace"` `"delete"`
avi_api_update_method строка	Метод обновления объекта по умолчанию — HTTP PUT. Установка значения в patch переопределит это поведение, чтобы использовать HTTP PATCH. Выбор: `"put"` ← (по умолчанию) `"patch"`
avi_credentials словарь	Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в систему контроллера Avi.
api_version строка	Версия контроллера Avi По умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера
csrftoken строка	Маркер csrf контроллера API Avi для повторного использования существующей сессии с идентификатором сессии По умолчанию: `""`
password строка	Пароль контроллера Avi
port строка	Порт контроллера Avi
session_id строка	Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken По умолчанию: `""`
tenant строка	Тенент контроллера Avi По умолчанию: `"admin"`
tenant_uuid строка	UUID тенента контроллера Avi По умолчанию: `""`
timeout строка	Таймаут запроса контроллера Avi По умолчанию: `300`
token строка	Токен API контроллера Avi По умолчанию: `""`
username строка	Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact логический	Отключает кеширование информации о сессии avi в качестве факта. Выбор: `false` ← (по умолчанию) `true`
cloud_config_cksum строка	Контрольная сумма конфигурации облака для политики безопасности сети. Внутренне устанавливается подключением к облаку.
controller строка	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`
created_by строка	Имя создателя.
description строка	Определяемая пользователем строка описания объекта.
name строка	Имя объекта.

пароль строка	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения `AVI_PASSWORD`.
правила строка	Список networksecurityrule.
состояние строка	Состояние, которое должно быть применено к объекту. Варианты: `"absent"` `"present"` ← (по умолчанию)
арендатор строка	Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `"admin"`
ссылка_арендатора строка	Ссылка на объект типа арендатор.
uuid_арендатора строка	UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. По умолчанию: `""`
url строка	URL контроллера Avi для объекта.
имя_пользователя строка	Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения `AVI_USERNAME`.
uuid строка	Уникальный идентификатор объекта.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Create a network security policy to block clients represented by ip group known_attackers
  community.network.avi_networksecuritypolicy:
    controller: '{{ controller }}'
    username: '{{ username }}'
    password: '{{ password }}'
    name: vs-gurutest-ns
    rules:
    - action: NETWORK_SECURITY_POLICY_ACTION_TYPE_DENY
      age: 0
      enable: true
      index: 1
      log: false
      match:
        client_ip:
          group_refs:
          - Demo:known_attackers
          match_criteria: IS_IN
      name: Rule 1
    tenant_ref: Demo

Возвращаемые значения

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

Ключ	Описание
obj словарь	Объект NetworkSecurityPolicy (api/networksecuritypolicy) Возвращается: успех, изменено

Авторы

Gaurav Rastogi (@grastogi23)

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

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