Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_networkflowlog – Управление журналами сетевого потока

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

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

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

Для использования в плейбуке укажите: azure.azcollection.azure_rm_networkflowlog.

Новая в azure.azcollection 2.5.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Описание

  • Создание, обновление или удаление журналов сетевого потока.

Требования

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

  • python >= 2.7
  • На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
  • Все пакеты python, указанные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection
  • Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

append_tags

boolean

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

В каноническом виде любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.

Choices:

  • false
  • true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных, используемых для аутентификации.

Также может быть установлен через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.

При установке в auto (по умолчанию) приоритет имеет параметры модуля -> env -> credential_file -> cli.

При установке в env, учетные данные будут считываться из переменных среды

При установке в credential_file, он будет читать профиль из ~/.azure/credentials.

При установке в cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию.

При установке в msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка.

Параметр msi был добавлен в Ansible 2.6.

Choices:

  • "auto" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Choices:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi).

Также может быть установлен через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

disable_instance-discovery

boolean

added in azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя извлечение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате важно убедиться, что настроенный узел полномочий является действительным и заслуживающим доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Choices:

  • false ← (default)
  • true

enabled

boolean

Флаг для включения/отключения ведения журнала потоков.

Choices:

  • false
  • true

flow_analytics_configuration

dictionary

Параметры, определяющие конфигурацию анализа трафика.

network_watcher_flow_analytics_configuration

dictionary

Параметры, определяющие конфигурацию анализа трафика.

enabled

boolean

Флаг для включения/отключения анализа трафика.

Choices:

  • false
  • true

traffic_analytics_interval

integer

Интервал в минутах, определяющий частоту выполнения анализа потоков службой TA.

Выбираемые значения:

  • 10
  • 60

workspace_id

string

Уникальный идентификатор (GUID) подключенного рабочего пространства.

workspace_region

string

Расположение подключенного рабочего пространства.

workspace_resource_id

string

Идентификатор ресурса подключенного рабочего пространства.

location

string

Действительное расположение Azure. По умолчанию используется расположение группы ресурсов.

log_mode

string

Аргумент родительского уровня.

log_path

string

Аргумент родительского уровня.

name

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

Название журнала сетевых потоков.

network_watcher_name

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

Название наблюдателя сети.

password

string

Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory вместо службы-принципала.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

resource_group

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

Имя группы ресурсов.

retention_policy

dictionary

Параметры, определяющие политику хранения журналов потоков.

days

integer

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

enabled

boolean

Флаг для включения/выключения хранения.

Выбираемые значения:

  • false
  • true

secret

string

Секретный ключ клиента Azure. Используется при аутентификации с помощью службы-принципала.

state

string

Состояние журналов потоков. Используйте present для создания или обновления и absent для удаления.

Выбираемые значения:

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

storage_id

string

Идентификатор хранилища учетной записи, используемого для хранения журналов потоков.

subscription_id

string

Ваш идентификатор подписки Azure.

tags

dictionary

Словарь пар «строка:строка» для присвоения метаданных объекту.

Метаданные теги объекта будут обновлены любыми предоставленными значениями.

Для удаления тегов установите параметр append_tags в false.

В настоящее время службы Azure DNS и Traffic Manager также не позволяют использовать пробелы в теге.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах.

target_resource_id

string

Идентификатор группы безопасности сети, к которой будет применено хранение журнала потоков.

tenant

string

Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала.

thumbprint

string

добавлен в azure.azcollection 1.14.0

Отпечаток цифрового сертификата, указанного в x509_certificate_path.

Используется при аутентификации с помощью службы-принципала.

Требуется, если задано x509_certificate_path.

END_OF_DOCUMENT_MARKER

x509_certificate_path

path

added in azure.azcollection 1.14.0

Путь к сертификату X509, используемому для создания служебного принципала в формате PEM.

Сертификат должен быть присоединен к закрытому ключу.

Используется при аутентификации с помощью служебного принципала.

Примечания

Примечание

  • Для аутентификации с Azure можно передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед выполнением задач или плейбука с помощью az login.
  • Аутентификация также возможна с использованием служебного принципала или пользователя Active Directory.
  • Для аутентификации через служебного принципала передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
  • Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
  • В качестве альтернативы учетные данные можно сохранить в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

См. также

Вход с помощью Azure CLI

Как аутентифицироваться с помощью команды az login.

Примеры

- name: Create network flow log
  azure_rm_networkflowlog:
    resource_group: NetworkWatcherRG
    network_watcher_name: NetworkWatcher_eastus
    name: xz3mlwvnet-xz3mlwaiserv-flowlog02
    enabled: false
    flow_analytics_configuration:
      network_watcher_flow_analytics_configuration:
        enabled: false
        traffic_analytics_interval: 60
        workspace_id: 7c16a8dd-b983-4f75-b78b-a804c169306c
        workspace_region: eastus
        workspace_resource_id: "/subscriptions/xxx-xxx/resourceGroups/DefaultRG-EUS/providers/Microsoft.OperationalInsights/workspaces/DeWorkspace-0-EUS"
    retention_policy:
      days: 2
      enabled: true
    storage_id: "/subscriptions/xxx-xxx/resourceGroups/AutoTagFunctionAppRG/providers/Microsoft.Storage/storageAccounts/autotagfunctionappr9a08"
    target_resource_id: "/subscriptions/xxx-xxx/resourceGroups/xz3mlwaiserv/providers/Microsoft.Network/virtualNetworks/xz3mlwvnet"
    tags:
      key2: value2
      key5: value5

- name: Delete a Flow Logs
  azure_rm_networkflowlog:
    resource_group: myResourceGroup
    network_watcher_name: testwatcher
    name: myNetflowlog
    state: absent

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

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

Ключ

Описание

state

complex

Факты о логах сетевого потока.

Возвращается: всегда

enanbled

string

Флаг для включения/отключения ведения журнала потоков.

Возвращается: всегда

Пример: "True"

flow_analytics_configuration

complex

Параметры, определяющие конфигурацию анализа трафика.

Возвращается: всегда

network_watcher_flow_analytics_configuration

complex

Параметры, определяющие конфигурацию анализа трафика.

Возвращается: всегда

enabled

boolean

Флаг для включения/отключения анализа трафика.

Возвращается: всегда

Пример: true

traffic_analytics_interval

string

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

Возвращается: всегда

Пример: "60"

workspace_id

string

GUID ресурса подключенной рабочей области.

Возвращается: всегда

Пример: "7c16a8dd-b983-4f75-b78b-a804c169306c"

workspace_region

string

Расположение подключенной рабочей области.

Возвращается: всегда

Пример: "eastus"

workspace_resource_id

string

ID ресурса подключенной рабочей области.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/DefaulUS/providers/Microsoft.OperationalInsights/workspaces/DefaultWorkspace-0-EUS\""

id

string

ID ресурса.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/NetWatcherRG/providers/Microsoft.Network/networkWatchers/NetWatcher_eastus/flowLogs/xz-flowlog\""

location

string

Расположение ресурса.

Возвращается: всегда

Пример: "eastus"

name

string

Имя ресурса.

Возвращается: всегда

Пример: "xz-flowlog"

network_watcher_name

string

Имя средства наблюдения за сетью.

Возвращается: всегда

Пример: "NetWatcher_eastus"

provisioning_state

string

Состояние подготовки ресурса журналов сетевого потока.

Возвращается: всегда

Пример: "Succeeded"

resource_group

string

Группа ресурсов.

Возвращается: всегда

Пример: "NetworkWatcherRG"

retention_policy

complex

Параметры, определяющие политику хранения для журнала потоков.

Возвращается: всегда

day

integer

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

Возвращается: всегда

Пример: 0

enabled

boolean

Флаг для включения/выключения удержания.

Возвращается: всегда

Пример: false

storage_id

string

Идентификатор учетной записи хранилища, используемой для хранения журнала потоков.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/AutoTagFunctionAppRG/providers/Microsoft.Storage/storageAccounts/autotagfunc01"

tags

dictionary

Теги ресурса.

Возвращается: всегда

Пример: {"key1": "value1"}

target_resource_id

string

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

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/xz3mlwaiserv/providers/Microsoft.Network/virtualNetworks/xz3mlwvnet\""

type

string

Тип ресурса.

Возвращается: всегда

Пример: "Microsoft.Network/networkWatchers/flowLogs"

Авторы

  • xuzhang3 (@xuzhang3)
  • Fred-sun (@Fred-sun)

Ссылки на сборку

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

© 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/azure/azcollection/azure_rm_networkflowlog_module.html

Spec-Zone.ru

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