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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в playbook укажите: 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	Объект словаря, содержащий сведения о подключении.
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

boolean

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

Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS.

Варианты:

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

state

string

Когда 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 string	Время дня, когда правило перестанет действовать. Возвращается: changed Пример: `"18:00"`
daily_hour_start string	Время дня, когда правило начнёт действовать. Возвращается: changed Пример: `"13:00"`
date_valid_end string	Конечная дата/время, до которой будет применяться расписание к правилу. Возвращается: changed Пример: `"2019-03-11:15:30:00"`
date_valid_start string	Начальная дата/время, с которой будет применяться расписание к правилу. Возвращается: changed Пример: `"2019-03-01:15:30:00"`
days_of_week list / elements=string	Дни недели, когда правило будет применяться. Возвращается: changed Пример: `["monday", "tuesday"]`
description string	Текст пользовательского описания. Возвращается: changed Пример: `"Foo is bar"`

Авторы

Wojciech Wypior (@wojtek0806)

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

© 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/f5networks/f5_modules/bigip_firewall_schedule_module.html