Модуль fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscaletgwnewvpc – Облачная оркестрация awstemplate автомасштабирования tgw новой сети VPC

Примечание

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

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

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

Чтобы использовать ее в книге задач, укажите: fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscaletgwnewvpc.

Добавлена в fortinet.fortimanager 2.2.0

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

Описание

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать для использования данных из источников.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливать в значение True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (default) `true`
cloud_orchestawstemplate_autoscaletgwnewvpc dictionary	Набор параметров верхнего уровня.
availability-zones string	Устарело, переименуйте в availability_zones. Зоны доступности.
bgp-asn integer	Устарело, переименуйте в bgp_asn. ASN BGP.
custom-asset-container string	Устарело, переименуйте в custom_asset_container. Контейнер пользовательских ресурсов.
custom-asset-directory string	Устарело, переименуйте в custom_asset_directory. Каталог пользовательских ресурсов.
custom-identifier string	Устарело, переименуйте в custom_identifier. Пользовательский идентификатор.
faz-autoscale-admin-password any	(list) Устарело, переименуйте в faz_autoscale_admin_password. Пароль администратора автомасштабирования FAZ.
faz-autoscale-admin-username string	Устарело, переименуйте в faz_autoscale_admin_username. Имя пользователя администратора автомасштабирования FAZ.
faz-custom-private-ipaddress string	Устарело, переименуйте в faz_custom_private_ipaddress. Пользовательский частный IP-адрес FAZ.
faz-instance-type string	Устарело, переименуйте в faz_instance_type. Тип экземпляра FAZ. Варианты: `"h1.2xlarge"` `"h1.4xlarge"` `"h1.8xlarge"` `"m5.large"` `"m5.xlarge"` `"m5.2xlarge"` `"m5.4xlarge"` `"m5.12xlarge"` `"t2.medium"` `"t2.large"` `"t2.xlarge"`
faz-integration-options string	Устарело, переименуйте в faz_integration_options. Варианты интеграции FAZ. Варианты: `"no"` `"yes"`
faz-version string	Устарело, переименуйте в faz_version. Версия FAZ.
fgt-admin-cidr string	Устарело, переименуйте в fgt_admin_cidr. CIDR администратора FGT.
fgt-admin-port integer	Устарело, переименуйте в fgt_admin_port. Порт администратора FGT.
fgt-instance-type string	Устарело, переименуйте в fgt_instance_type. Тип экземпляра FGT. Варианты: `"t2.small"` `"c5.large"` `"c5.xlarge"` `"c5.2xlarge"` `"c5.4xlarge"` `"c5.9xlarge"`
fgt-psk-secret string	Устарело, переименуйте в fgt_psk_secret. Секретный ключ PSK FGT.

fgtasg-cool-down integer	Устарело, переименуйте в fgtasg_cool_down. Время охлаждения Fgtasg.
fgtasg-desired-capacity-byol integer	Устарело, переименуйте в fgtasg_desired_capacity_byol. Требуемая емкость Fgtasg BYOL.
fgtasg-desired-capacity-payg integer	Устарело, переименуйте в fgtasg_desired_capacity_payg. Требуемая емкость Fgtasg PAYG.
fgtasg-health-check-grace-period integer	Устарело, переименуйте в fgtasg_health_check_grace_period. Период ожидания проверки работоспособности Fgtasg.
fgtasg-max-size-byol integer	Устарело, переименуйте в fgtasg_max_size_byol. Максимальный размер Fgtasg BYOL.
fgtasg-max-size-payg integer	Устарело, переименуйте в fgtasg_max_size_payg. Максимальный размер Fgtasg PAYG.
fgtasg-min-size-byol integer	Устарело, переименуйте в fgtasg_min_size_byol. Минимальный размер Fgtasg BYOL.
fgtasg-min-size-payg integer	Устарело, переименуйте в fgtasg_min_size_payg. Минимальный размер Fgtasg PAYG.
fgtasg-scale-in-threshold integer	Устарело, переименуйте в fgtasg_scale_in_threshold. Порог уменьшения масштаба Fgtasg.
fgtasg-scale-out-threshold integer	Устарело, переименуйте в fgtasg_scale_out_threshold. Порог увеличения масштаба Fgtasg.
fos-version string	Устарело, переименуйте в fos_version. Версия FOS.
get-license-grace-period integer	Устарело, переименуйте в get_license_grace_period. Период льготного использования лицензии.
heartbeat-delay-allowance integer	Устарело, переименуйте в heartbeat_delay_allowance. Допустимая задержка сигнала.
heartbeat-interval integer	Устарело, переименуйте в heartbeat_interval. Интервал сигнала.
heartbeat-loss-count integer	Устарело, переименуйте в heartbeat_loss_count. Количество потерянных сигналов.
key-pair-name string	Устарело, переименуйте в key_pair_name. Имя пары ключей.
lifecycle-hook-timeout integer	Устарело, переименуйте в lifecycle_hook_timeout. Время ожидания хука жизненного цикла.
name string / required	Имя.
notification-email string	Устарело, переименуйте в notification_email. Email для уведомлений.
primary-election-timeout integer	Устарело, переименуйте в primary_election_timeout. Время ожидания выбора основного устройства.
public-subnet1-cidr string	Устарело, переименуйте в public_subnet1_cidr. CIDR-адрес подсети 1.

public-subnet2-cidr строка	Устаревшее, пожалуйста, переименуйте на public_subnet2_cidr. CIDR общедоступной подсети 2.
resource-tag-prefix строка	Устаревшее, пожалуйста, переименуйте на resource_tag_prefix. Префикс тега ресурса.
s3-bucket-name строка	Устаревшее, пожалуйста, переименуйте на s3_bucket_name. Название ведра S3.
s3-key-prefix строка	Устаревшее, пожалуйста, переименуйте на s3_key_prefix. Префикс ключа S3.
sync-recovery-count целое число	Устаревшее, пожалуйста, переименуйте на sync_recovery_count. Количество синхронизаций восстановления.
terminate-unhealthy-vm строка	Устаревшее, пожалуйста, переименуйте на terminate_unhealthy_vm. Прекратить работу неисправной виртуальной машины. Варианты: `"no"` `"yes"`
transit-gateway-id строка	Устаревшее, пожалуйста, переименуйте на transit_gateway_id. ID транзитного шлюза.
transit-gateway-support-options строка	Устаревшее, пожалуйста, переименуйте на transit_gateway_support_options. Параметры поддержки транзитного шлюза. Варианты: `"create one"` `"use an existing one"`
use-custom-asset-location строка	Устаревшее, пожалуйста, переименуйте на use_custom_asset_location. Использовать пользовательское расположение активов. Варианты: `"no"` `"yes"`
vpc-cidr строка	Устаревшее, пожалуйста, переименуйте на vpc_cidr. CIDR VPC.
enable_log логический тип	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентифицировать Ansible-клиент с токеном доступа к API forticloud.
proposed_method строка	Переопределённый метод для запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут считаться ошибочными.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут считаться успешными.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки в режиме работы в рабочей области FortiManager, значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют обозначение с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name” на “var_name”. Старые имена аргументов всё ещё доступны, но вы получите предупреждения о устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Поддержка работы в режиме блокировки рабочей области реализована в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно, выполнение одного модуля может завершиться ошибкой при возвращении ненулевого rc. Вы также можете переопределить условия для ошибки или успеха с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Cloud orchest awstemplate autoscale tgw new vpc
      fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscaletgwnewvpc:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        cloud_orchestawstemplate_autoscaletgwnewvpc:
          availability_zones: <string>
          bgp_asn: <integer>
          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>
          key_pair_name: <string>
          lifecycle_hook_timeout: <integer>
          name: <string>
          notification_email: <string>
          primary_election_timeout: <integer>
          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]>
          transit_gateway_id: <string>
          transit_gateway_support_options: <value in [create one, use an existing one]>
          use_custom_asset_location: <value in [no, yes]>
          vpc_cidr: <string>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге команд, не поддерживаются текущей версией FortiManager. Возвращается: сложный

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortinet/fortimanager/fmgr_cloud_orchestawstemplate_autoscaletgwnewvpc_module.html