aci_fabric_scheduler – Этот модуль создаёт планировщики ACI
Новая версия с 2.8.
Обзор
- С помощью модуля можно создать политики планирования, которые могут быть оболочкой, однократным выполнением или повторяющимися
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| certificate_name строка | Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если было предоставлено имя файла private_key, по умолчанию используется имя файла private_key, без расширения.Если для private_key был предоставлен контент в формате PEM, по умолчанию используется значение username. псевдонимы: cert_name | |
| concurCap целое число | Это количество устройств, которые могут быть выполнены одновременно. | |
| date - | Это дата и время, когда планировщик выполнит задачу. | |
| day - |
| Это задаёт день, когда выполнение состоится. |
| description - | Описание планировщика. псевдонимы: descr | |
| host строка / обязательно | IP-адрес или имя хоста APIC, разрешаемое хостом управления Ansible. псевдонимы: hostname | |
| hour - | Это устанавливает час выполнения. | |
| maxTime - | Это максимальное время выполнения процесса. | |
| minute - | Это устанавливает минуту выполнения, используется совместно с часом. | |
| name - / обязательно | Имя планировщика. псевдонимы: name, scheduler_name | |
| output_level строка |
| Влияет на вывод этого модуля ACI. normal означает стандартный вывод, включая current словарь.info добавляет информационный вывод, включая previous, proposed и sent словари.debug добавляет отладочный вывод, включая filter_string, method, response, status и url информацию. |
| password строка / обязательно | Пароль для аутентификации. Этот параметр взаимоисключающий с private_key. Если также указан private_key, он будет использован вместо этого. | |
| port целое число | Номер порта для использования в соединении REST. Значение по умолчанию зависит от параметра use_ssl. | |
| private_key строка / обязательно | Файл с закрытым ключом в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию certificate_name, которое используется.Этот параметр взаимоисключающий с password. Если также указан password, он будет проигнорирован.псевдонимы: cert_key | |
| recurring логическое значение |
| Если требуется сделать планировщик повторяющимся, значение должно быть "True", а для однократного выполнения - "False". Для оболочки просто исключите этот параметр из задачи. |
| state - |
| Используйте present или absent для добавления или удаления.Используйте query для получения списка объекта или нескольких объектов. |
| timeout целое число | Значение по умолчанию: 30 | Таймаут сокета в секундах. |
| use_proxy логическое значение |
| Если no, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. |
| use_ssl логическое значение |
| Если no, вместо соединения HTTPS будет использовано HTTP-соединение. |
| username строка | Значение по умолчанию: "admin" | Имя пользователя для аутентификации. псевдонимы: user |
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверены.Это следует установить в no только при использовании на контролируемых сайтах с самозаверяющимися сертификатами. |
| windowname - | Имя для повторяющегося или однократного выполнения. |
См. также
См. также
- Руководство по Cisco ACI
- Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
- Разработка модулей Cisco ACI
- Подробное руководство по написанию собственных модулей Cisco ACI для участия в сообществе.
Примеры
- name: Simple Scheduler (Empty)
aci_fabric_scheduler:
host: "{{ inventory_hostname }}"
username: "{{ user }}"
password: "{{ pass }}"
validate_certs: no
name: simpleScheduler
state: present
- name: Remove Simple Scheduler
aci_fabric_scheduler:
host: "{{ inventory_hostname }}"
username: "{{ user }}"
password: "{{ pass }}"
validate_certs: no
name: simpleScheduler
state: absent
- name: One Time Scheduler
aci_fabric_scheduler:
host: "{{ inventory_hostname }}"
username: "{{ user }}"
password: "{{ pass }}"
validate_certs: no
name: OneTime
windowname: OneTime
recurring: False
concurCap: 20
date: "2018-11-20T24:00:00"
state: present
- name: Recurring Scheduler
aci_fabric_scheduler:
host: "{{ inventory_hostname }}"
username: "{{ user }}"
password: "{{ pass }}"
validate_certs: no
name: Recurring
windowname: Recurring
recurring: True
concurCap: 20
hour: 13
minute: 30
day: Tuesday
state: present
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| current список | успех | Текущая конфигурация из APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}] |
| error словарь | ошибка | Информация об ошибке, возвращённая APIC Пример: {'code': '122', 'text': 'неизвестный класс управляемого объекта foo'} |
| filter_string строка | ошибка или отладка | Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only |
| method строка | ошибка или отладка | HTTP-метод, используемый для запроса к APIC Пример: POST |
| previous список | информация | Исходная конфигурация из APIC до запуска модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производство', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}] |
| proposed словарь | информация | Собраная конфигурация из предоставленных пользователем параметров Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'production'}}} |
| raw строка | ошибка разбора | Необработанный результат, возвращённый API REST APIC (xml или json) Пример: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="неизвестный класс управляемого объекта foo"/></imdata> |
| response строка | ошибка или отладка | HTTP-ответ от APIC Пример: OK (30 байт) |
| sent список | информация | Фактическая/минимальная конфигурация, отправленная в APIC Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда'}}} |
| status целое число | ошибка или отладка | HTTP-статус от APIC Пример: 200 |
| url строка | ошибка или отладка | HTTP-URL, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Steven Gerhart (@sgerhart)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/aci_fabric_scheduler_module.html