Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_firewall_schedule — управление конфигурациями расписаний BIG-IP AFM

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

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

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

Чтобы использовать коллекцию в плейбуке, укажите: f5networks.f5_modules.bigip_firewall_schedule.

Добавлено в f5networks.f5_modules 1.0.0

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

Обзор

  • Управление конфигурациями расписаний BIG-IP AFM (Advanced Firewall Manager).

Параметры

Параметр

Описание

daily_hour_end

строка

Задает время суток, после которого правило перестанет применяться.

Если параметр не задан, при создании расписания используется значение по умолчанию 24:00.

Предполагается, что часовой пояс всегда UTC. Значения необходимо указывать в формате HH:MM, используя 24-часовой формат времени.

daily_hour_start

строка

Задает время суток, с которого правило начнет применяться.

Значение должно предшествовать daily_hour_end.

Если параметр не задан, при создании расписания используется значение по умолчанию 0:00.

Если для параметра задано значение all-day, параметры daily_hour_end и daily_hour_start сбрасываются до соответствующих значений по умолчанию.

Предполагается, что часовой пояс всегда UTC. Значения необходимо указывать в формате HH:MM, используя 24-часовой формат времени.

date_valid_end

строка

Задает дату и время окончания действия этого расписания для правила.

Дата должна быть позже date_valid_start

Если параметр не задан, при создании расписания используется значение по умолчанию indefinite.

Предполагается, что часовой пояс всегда UTC.

Дата и время всегда должны быть указаны в формате YYYY-MM-DD:HH:MM:SS.

date_valid_start

строка

Задает дату и время начала действия этого расписания для правила.

Если параметр не задан, при создании расписания используется значение по умолчанию epoch.

Предполагается, что часовой пояс всегда UTC.

Дата и время всегда должны быть указаны в формате YYYY-MM-DD:HH:MM:SS.

days_of_week

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

Задает дни недели, в которые будет применяться правило.

Если параметр не задан, при создании расписания используется значение по умолчанию all.

Значение all нельзя использовать одновременно с другими вариантами.

Варианты:

  • "sunday"
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"
  • "all"

description

строка

Задает описание, определяемое пользователем.

name

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

Задает имя конфигурации расписания AFM.

partition

строка

Раздел устройства, в котором будут управляться ресурсы.

По умолчанию: "Common"

provider

словарь

добавлено в f5networks.f5_modules 1.0.0

Объект dict, содержащий сведения для подключения.

auth_provider

строка

Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства.

Этот параметр используется преимущественно при работе с устройствами BIG-IQ.

no_f5_teem

логический

Если yes, данные телеметрии TEEM не отправляются в F5.

Этот параметр можно не указывать, задав переменную окружения F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM объявлена устаревшей, так как ее имя вводило в заблуждение.

Варианты:

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

password

псевдонимы: pass, pwd

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

Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную окружения F5_PASSWORD.

server

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

Имя хоста BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную окружения F5_SERVER.

server_port

целое число

Порт сервера BIG-IP.

Этот параметр можно не указывать, задав переменную окружения F5_SERVER_PORT.

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

timeout

целое число

Задает время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечет до завершения операции, модуль завершится с ошибкой.

transport

строка

Настраивает транспортное соединение, используемое для подключения к удаленному устройству.

Варианты:

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

user

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

Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве.

Этот параметр можно не указывать, задав переменную окружения F5_USER.

validate_certs

логический

Если no, SSL-сертификаты не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами.

Этот параметр можно не указывать, задав переменную окружения F5_VALIDATE_CERTS.

Варианты:

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

state

строка

Если задано значение present, ресурс будет существовать.

Если задано значение absent, ресурс будет удален.

Варианты:

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

Примечания

Примечание

  • Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется BIG-IP версии >= 12.
  • Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы сохранить специфичную для BIG-IP конфигурацию на диск, обязательно добавьте хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Правильный способ сохранения текущей конфигурации см. в документации модуля.

Примеры

- name: Create a 6 hour two day schedule, no start/end date
  bigip_firewall_schedule:
    name: barfoo
    daily_hour_start: 13:00
    daily_hour_end: 19:00
    days_of_week:
      - monday
      - tuesday
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a seven day schedule with start/end date
  bigip_firewall_schedule:
    name: foobar
    date_valid_start: "{{ lookup('pipe','date +%Y-%m-%d:%H:%M:%S') }}"
    date_valid_end: "{{ lookup('pipe','date -d \"now + 7 days\" +%Y-%m-%d:%H:%M:%S') }}"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify created schedule to all-day
  bigip_firewall_schedule:
    name: barfoo
    daily_hour_start: all-day
    days_of_week:
      - monday
      - tuesday
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify a schedule to have no end date
  bigip_firewall_schedule:
    name: foobar
    date_valid_start: "{{ lookup('pipe','date +%Y-%m-%d:%H:%M:%S') }}"
    date_valid_end: "indefinite"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove created schedule
  bigip_firewall_schedule:
    name: foobar
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ

Описание

daily_hour_end

строка

Время суток, после которого правило перестанет применяться.

Возвращается: при изменении

Пример: "18:00"

daily_hour_start

строка

Время суток, с которого правило начнет применяться.

Возвращается: при изменении

Пример: "13:00"

date_valid_end

строка

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

Возвращается: при изменении

Пример: "2019-03-11:15:30:00"

date_valid_start

строка

Дата и время начала действия расписания для правила.

Возвращается: при изменении

Пример: "2019-03-01:15:30:00"

days_of_week

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

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

Возвращается: при изменении

Пример: ["monday", "tuesday"]

description

строка

Описание, определяемое пользователем.

Возвращается: при изменении

Пример: "Foo is bar"

Авторы

  • Wojciech Wypior (@wojtek0806)

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

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_firewall_schedule_module.html

Spec-Zone.ru

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