fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscalenewvpc module – Шаблон Cloud orchest для автоматического масштабирования новой VPC в AWS
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscalenewvpc.
Добавлен в fortinet.fortimanager 2.2.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
cloud_orchestawstemplate_autoscalenewvpc dictionary | Набор параметров верхнего уровня. |
|
availability_zones псевдонимы: availability-zones string |
Зоны доступности. |
|
custom_asset_container псевдонимы: custom-asset-container string |
Пользовательский контейнер ресурсов. |
|
custom_asset_directory псевдонимы: custom-asset-directory string |
Пользовательский каталог ресурсов. |
|
custom_identifier псевдонимы: custom-identifier string |
Пользовательский идентификатор. |
|
faz_autoscale_admin_password псевдонимы: faz-autoscale-admin-password any |
(список) Пароль администратора автомасштабирования Faz. |
|
faz_autoscale_admin_username псевдонимы: faz-autoscale-admin-username string |
Имя пользователя администратора автомасштабирования Faz. |
|
faz_custom_private_ipaddress псевдонимы: faz-custom-private-ipaddress string |
Пользовательский частный IP-адрес Faz. |
|
faz_instance_type псевдонимы: faz-instance-type string |
Тип экземпляра Faz. Варианты:
|
|
faz_integration_options псевдонимы: faz-integration-options string |
Параметры интеграции Faz. Варианты:
|
|
faz_version псевдонимы: faz-version string |
Версия Faz. |
|
fgt_admin_cidr псевдонимы: fgt-admin-cidr string |
Административный CIDR Fgt. |
|
fgt_admin_port псевдонимы: fgt-admin-port integer |
Административный порт Fgt. |
|
fgt_instance_type псевдонимы: fgt-instance-type string |
Тип экземпляра Fgt. Варианты:
|
|
fgt_psk_secret псевдонимы: fgt-psk-secret string |
Секрет предварительно согласованного ключа (PSK) Fgt. |
|
fgtasg_cool_down псевдонимы: fgtasg-cool-down integer |
Период ожидания Fgtasg. |
|
fgtasg_desired_capacity_byol псевдонимы: fgtasg-desired-capacity-byol integer |
Желаемая емкость Fgtasg для BYOL. |
|
fgtasg_desired_capacity_payg псевдонимы: fgtasg-desired-capacity-payg integer |
Желаемая емкость Fgtasg для PAYG. |
|
fgtasg_health_check_grace_period псевдонимы: fgtasg-health-check-grace-period integer |
Льготный период проверки работоспособности Fgtasg. |
|
fgtasg_max_size_byol псевдонимы: fgtasg-max-size-byol integer |
Максимальный размер Fgtasg для BYOL. |
|
fgtasg_max_size_payg псевдонимы: fgtasg-max-size-payg integer |
Максимальный размер Fgtasg для PAYG. |
|
fgtasg_min_size_byol псевдонимы: fgtasg-min-size-byol integer |
Минимальный размер Fgtasg для BYOL. |
|
fgtasg_min_size_payg псевдонимы: fgtasg-min-size-payg integer |
Минимальный размер Fgtasg для PAYG. |
|
fgtasg_scale_in_threshold псевдонимы: fgtasg-scale-in-threshold integer |
Порог масштабирования Fgtasg внутрь. |
|
fgtasg_scale_out_threshold псевдонимы: fgtasg-scale-out-threshold integer |
Порог масштабирования Fgtasg наружу. |
|
fos_version псевдонимы: fos-version string |
Версия Fos. |
|
get_license_grace_period псевдонимы: get-license-grace-period integer |
Получить льготный период лицензии. |
|
heartbeat_delay_allowance псевдонимы: heartbeat-delay-allowance integer |
Допустимая задержка сигнала проверки активности. |
|
heartbeat_interval псевдонимы: heartbeat-interval integer |
Интервал отправки сигнала проверки активности. |
|
heartbeat_loss_count псевдонимы: heartbeat-loss-count integer |
Количество пропущенных сигналов проверки активности. |
|
internal_balancer_dns_name псевдонимы: internal-balancer-dns-name string |
DNS-имя внутреннего балансировщика. |
|
internal_balancing_options псевдонимы: internal-balancing-options string |
Параметры внутренней балансировки. Варианты:
|
|
internal_target_group_health_check_path псевдонимы: internal-target-group-health-check-path string |
Путь проверки работоспособности внутренней целевой группы. |
|
key_pair_name псевдонимы: key-pair-name string |
Имя пары ключей. |
|
lifecycle_hook_timeout псевдонимы: lifecycle-hook-timeout integer |
Тайм-аут перехватчика жизненного цикла. |
|
loadbalancing_health_check_threshold псевдонимы: loadbalancing-health-check-threshold integer |
Порог проверки работоспособности балансировки нагрузки. |
|
loadbalancing_traffic_port псевдонимы: loadbalancing-traffic-port integer |
Порт трафика балансировки нагрузки. |
|
loadbalancing_traffic_protocol псевдонимы: loadbalancing-traffic-protocol string |
Протокол трафика балансировки нагрузки. Варианты:
|
|
name string / обязательно |
Имя. |
|
notification_email псевдонимы: notification-email string |
Адрес электронной почты для уведомлений. |
|
primary_election_timeout псевдонимы: primary-election-timeout integer |
Тайм-аут выбора основного узла. |
|
private_subnet1_cidr псевдонимы: private-subnet1-cidr string |
CIDR частной подсети 1. |
|
private_subnet2_cidr псевдонимы: private-subnet2-cidr string |
CIDR частной подсети 2. |
|
public_subnet1_cidr псевдонимы: public-subnet1-cidr string |
CIDR общедоступной подсети 1. |
|
public_subnet2_cidr псевдонимы: public-subnet2-cidr string |
CIDR общедоступной подсети 2. |
|
resource_tag_prefix псевдонимы: resource-tag-prefix string |
Префикс тегов ресурсов. |
|
s3_bucket_name псевдонимы: s3-bucket-name string |
Имя бакета S3. |
|
s3_key_prefix псевдонимы: s3-key-prefix string |
Префикс ключа S3. |
|
sync_recovery_count псевдонимы: sync-recovery-count integer |
Количество синхронных восстановлений. |
|
terminate_unhealthy_vm псевдонимы: terminate-unhealthy-vm string |
Завершить работу неисправной виртуальной машины. Варианты:
|
|
use_custom_asset_location псевдонимы: use-custom-asset-location string |
Использовать пользовательское расположение ресурсов. Варианты:
|
|
vpc_cidr псевдонимы: vpc-cidr string |
Блок CIDR VPC. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, при которых выполнение считается неудачным, переопределяется этим параметром. |
rc_succeeded list / elements=integer | Список кодов rc, при которых выполнение считается успешным, переопределяется этим параметром. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global или другие варианты, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, для всех входных аргументов используется соглашение об именовании с подчёркиваниями (snake_case). Замените аргументы, например “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но при их использовании будут появляться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Обычно выполнение модуля может завершиться ошибкой при возврате ненулевого кода rc. Условия, при которых выполнение считается неудачным или успешным, также можно переопределить с помощью параметров rc_failed и rc_succeeded.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Cloud orchest awstemplate autoscale new vpc
fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscalenewvpc:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
cloud_orchestawstemplate_autoscalenewvpc:
name: "your value" # Required variable, string
# availability_zones: <string>
# custom_asset_container: <string>
# custom_asset_directory: <string>
# custom_identifier: <string>
# faz_autoscale_admin_password: <list or string>
# faz_autoscale_admin_username: <string>
# faz_custom_private_ipaddress: <string>
# faz_instance_type: <value in [h1.2xlarge, h1.4xlarge, h1.8xlarge, ...]>
# faz_integration_options: <value in [no, yes]>
# faz_version: <string>
# fgt_admin_cidr: <string>
# fgt_admin_port: <integer>
# fgt_instance_type: <value in [t2.small, c5.large, c5.xlarge, ...]>
# fgt_psk_secret: <string>
# fgtasg_cool_down: <integer>
# fgtasg_desired_capacity_byol: <integer>
# fgtasg_desired_capacity_payg: <integer>
# fgtasg_health_check_grace_period: <integer>
# fgtasg_max_size_byol: <integer>
# fgtasg_max_size_payg: <integer>
# fgtasg_min_size_byol: <integer>
# fgtasg_min_size_payg: <integer>
# fgtasg_scale_in_threshold: <integer>
# fgtasg_scale_out_threshold: <integer>
# fos_version: <string>
# get_license_grace_period: <integer>
# heartbeat_delay_allowance: <integer>
# heartbeat_interval: <integer>
# heartbeat_loss_count: <integer>
# internal_balancer_dns_name: <string>
# internal_balancing_options: <value in [add a new internal load balancer, use a load balancer specified below, do not need one]>
# internal_target_group_health_check_path: <string>
# key_pair_name: <string>
# lifecycle_hook_timeout: <integer>
# loadbalancing_health_check_threshold: <integer>
# loadbalancing_traffic_port: <integer>
# loadbalancing_traffic_protocol: <value in [HTTPS, HTTP, TCP]>
# notification_email: <string>
# primary_election_timeout: <integer>
# private_subnet1_cidr: <string>
# private_subnet2_cidr: <string>
# public_subnet1_cidr: <string>
# public_subnet2_cidr: <string>
# resource_tag_prefix: <string>
# s3_bucket_name: <string>
# s3_key_prefix: <string>
# sync_recovery_count: <integer>
# terminate_unhealthy_vm: <value in [no, yes]>
# use_custom_asset_location: <value in [no, yes]>
# vpc_cidr: <string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 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/fortinet/fortimanager/fmgr_cloud_orchestawstemplate_autoscalenewvpc_module.html